Peach Finance

Notes

Get notes

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
personId
required
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

caseId
required
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

The case object unique identifier.

query Parameters
limit
integer [ 1 .. 100 ]
Default: 25

The maximum count of results to retrieve.

startingAfter
string

Return results starting after the provided object identifier.

endingBefore
string

Return results ending before the provided object identifier.

categories
Array of strings

Filters by the given note categories

Items Enum: "generic" "escalationCreateReason" "escalationUpdateReason" "escalationCancelReason"
includeArchived
boolean
Default: false

Include archived notes into the result

Responses
200

OK

get/people/{personId}/cases/{caseId}/notes
Response samples
application/json
{
  • "count": 0,
  • "data": [
    ]
}

Create note

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
personId
required
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

caseId
required
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

The case object unique identifier.

Request Body schema: application/json

The new note

status
string
Enum: "active" "inactive"
content
string

The content of the note.

important
boolean
Default: false

Set to true if the note is important.

category
string
Default: "generic"

Specifies the nature of a Note

Enum: "generic" "escalationCreateReason" "escalationUpdateReason" "escalationCancelReason"
sensitiveData
boolean
Default: false

Indicates whether the note contains sensitive information.

archived
boolean
Default: false

Set to true if the note has been archived.

taskableInstruction
boolean
Default: false

Set to true if the note is intended to be an instruction which creates a review task.

Responses
200

Success

post/people/{personId}/cases/{caseId}/notes
Request samples
application/json
{
  • "status": "active",
  • "content": "string",
  • "important": false,
  • "category": "generic",
  • "sensitiveData": false,
  • "archived": false,
  • "taskableInstruction": false
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Get note by ID

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
personId
required
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

caseId
required
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

The case object unique identifier.

noteId
required
string

The note identifier.

Responses
200

Success

get/people/{personId}/cases/{caseId}/notes/{noteId}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update note

Securityoauth2 or bearerAuth or apiKeyHeader
Request
path Parameters
personId
required
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

caseId
required
string^ext-|^[A-Z]{2}-[A-Z0-9]+-[A-Z0-9]+|^\d+$

The case object unique identifier.

noteId
required
string

The note identifier.

Request Body schema: application/json

Note fields

status
string
Enum: "active" "inactive"
content
string

The content of the note.

important
boolean
Default: false

Set to true if the note is important.

category
string
Default: "generic"

Specifies the nature of a Note

Enum: "generic" "escalationCreateReason" "escalationUpdateReason" "escalationCancelReason"
sensitiveData
boolean
Default: false

Indicates whether the note contains sensitive information.

archived
boolean
Default: false

Set to true if the note has been archived.

taskableInstruction
boolean
Default: false

Set to true if the note is intended to be an instruction which creates a review task.

Responses
200

Success

put/people/{personId}/cases/{caseId}/notes/{noteId}
Request samples
application/json
{
  • "status": "active",
  • "content": "string",
  • "important": false,
  • "category": "generic",
  • "sensitiveData": false,
  • "archived": false,
  • "taskableInstruction": false
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}
➔ Next to Workflows