Neighborly Software - OpenAPI 3.0

Schemas

Draw

idinteger
Example: 12345
caseIdinteger | null
Example: 12345
caseNamestring | null
Example: John Doe
statusinteger · enum
Status of the draw. Allowed values: 0 = Not Submitted 1 = Submitted 2 = Cancelled 3 = Pending Approval 4 = Approved 5 = Disbursed
Enum values:
0
1
2
3
4
5
Example: 0
requestedBystring
Example: example@cityofniceneighbors.gov
requestedDatestring · date-time
All times UTC
Example: 0001-01-01T00:00:00
amountRequestednumber | null · double
Example: 1000
approvedBystring | null
Example: example@cityofniceneighbors.gov
approvedDatestring | null · date-time
All times UTC
Example: 0001-01-01T00:00:00
amountApprovednumber | null · double
Example: 1000
disbursedBystring | null
Example: example@cityofniceneighbors.gov
disbursedDatestring | null · date-time
All times UTC
Example: 0001-01-01T00:00:00
amountDisbursednumber | null · double
Example: 1000
descriptionstring | null
Example: Some description
modifiedBystring
Example: example@cityofniceneighbors.gov
modifiedDatestring · date-time
All times UTC
Example: 0001-01-01T00:00:00
fieldAstring | null
Example: Field A value
fieldBstring | null
Example: Field B value
fieldCstring | null
Example: Field C value
fieldDstring | null
Example: Field D value
fieldEstring | null
Example: Field E value
configDrawApproverGroupIdinteger
Approver group to which this draw belongs. Approvers for a draw’s approval workflow are determined by the draws approver group.
Example: 123
workflowIdinteger
The id of the program(workflow) to which this draw's case belongs.
Example: 123

UpdateDraw

descriptionstring
Optional. Updates the draw description visible to participants.
participant_FieldAstring | null
Participant-facing custom field A. Optionally configurable field visible on draws in participant portal.
participant_FieldBstring | null
Participant-facing custom field B. Optionally configurable field visible on draws in participant portal.
participant_FieldCstring | null
Participant-facing custom field C. Optionally configurable field visible on draws in participant portal.
fieldAstring | null
Administrator-facing custom field A. Optionally configurable field visible on draws in administrator portal.
fieldBstring | null
Administrator-facing custom field B. Optionally configurable field visible on draws in administrator portal.
fieldCstring | null
Administrator-facing custom field C. Optionally configurable field visible on draws in administrator portal.
fieldDstring | null
Administrator-facing custom field D. Optionally configurable field visible on draws in administrator portal.
fieldEstring | null
Administrator-facing custom field E. Optionally configurable field visible on draws in administrator portal.
disbursedDatestring · date-time
Manually set the date the draw was disbursed. Rules:
- Only permitted if the workflow allows manual disbursement date updates.
- The draw must already be marked as "Disbursed"(status = 5).
  All times are in UTC.
Example: 2023-10-04T12:00:00
admin_Descriptionstring | null
Admin-facing description.
Rule: Only permitted if the workflow is configured to allow an admin description field.

Pagination

pageNumberinteger
The current page number
Example: 1
pageSizeinteger
The number of items per page
Example: 100
pageCountinteger
The total number of pages
Example: 5
totalRecordCountinteger
Total number of records available
Example: 500

Error

messagestring
detailsstring
suggestionstring

ErrorResponse

statusCodeinteger
errorobject

Loan

idinteger
caseIdinteger
createdDatestring · date-time
All times UTC
Example: 2023-10-04T12:00:00
statusIdinteger
hasPaymentsboolean
hasInterestboolean
hasForgivenessboolean
hasEscrowboolean
amountnumber · double
loanTerminteger | null
dateClosedstring | null · date-time
All times UTC
Example: 2023-10-04T12:00:00
calcPrincipalBalancenumber · double
calcInterestBalancenumber · double
calcFeesBalancenumber · double
calcPastDuenumber | null · double
maturityDatestring | null · date-time
All times UTC
Example: 2023-10-04T12:00:00

BulkDrawApproval

idinteger
The unique identifier of the draw.
drawobject
errorobject

DrawApprover

idinteger
Example: 123
workflowIdinteger
Id of the workflow(program) that this draw approver is used in. Filter by this property to see only draw approvers for a specific program.
namestring
typeinteger · enum
System code value designating type of approver. Possible values: 1 – Approval; 2 – Disbursement; 3 – PostDisbursement; 4 – StageForPayment; 5 – SentForPayment.
Enum values:
1
2
3
4
5
sortOrderinteger
The order in which this approver appears in the workflow. *Note - draw approver workflow ordered by type then sortOrder(if more than one approver of a given type).
modifiedBystring
Example: user@cityofniceneighbors.gov
modifiedDatestring · date-time
Example: 2023-10-04T12:00:00
preventRescindboolean
If true, approvals by this approver cannot be rescinded.
Example: false
configDrawApproverGroupIdinteger
The Id of the draw approver group. Used to group approvers together to define approval workflow for a draw.
Example: 456

DrawApproval

approverIdinteger · required
The ID of the draw approver. A list of available draw approvers can be retrieved via API(see developers.neighborlysoftware.com/api/configuration#list-draw-approvers), or viewed in the Neighborly portal under Configuration > Program Settings > Draw Approvers.
Example: 123

notesstring
Notes regarding the approval. Will be included in the audit log.
Example: Approved via NBLY API
notificationsEmailsstring[]
List of email addresses to notify upon approval.
Example: ["user1@cityofniceneighbors.com","user2@cityofniceneighbors.com"]