Statements

This object represents line of credit statements. Statements are created one calendar day after the period end date. Each statement is associated with one due dates. Number of dates between a statement creation and a due date can be configured by a lender. It's normally 14 or 21 days.

Get statements

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.

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

The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external 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.

sortBy
Array of strings

The data attributes by which to sort the results.

year
string

Only return statements from the current year.

includeAllVersions
boolean
Default: false

A flag to determine if all template versions should be returned, not just the most recent / active ones.

Responses
200

Collection of statements

get/people/{personId}/loans/{loanId}/statements
Response samples
application/json
{
  • "count": 0,
  • "data": [
    ]
}

Get statement details

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.

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

The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external identifier.

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

The statement object unique identifier.

Responses
200

Details for a single statement

get/people/{personId}/loans/{loanId}/statements/{statementId}/details
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update statement

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.

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

The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external identifier.

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

The statement object unique identifier.

Request Body schema: application/json
documentDescriptorId
required
string

Identifier for the document descriptor to be attached to the statement. This value can only be updated if isCreateAndSendPDF is set to false on the loan type configuration.

Responses
200

a single Statement

put/people/{personId}/loans/{loanId}/statements/{statementId}
Request samples
application/json
{
  • "documentDescriptorId": "string"
}
Response samples
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Generate statement

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 statement creation to finish. If it finishes in time, it will return the statement object. Otherwise, it will return nothing.

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.

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

The unique identifier of the Loan we wish to retrieve. Can be Peach or lender's external identifier.

periodId
required
string

Use this to limit results to a specific periodId.

query Parameters
sync
boolean
Default: false

Make the process synchronous.

sendNotice
boolean
Default: false

When set to true, the system will send a locStatementGenerated notice to the borrower.

Responses
201

Success

post/people/{personId}/loans/{loanId}/periods/{periodId}/generate-statement
Response samples
application/json
{
  • "processingComplete": true,
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}