Documents

Allows you to retrieve documents (similar to file downloads in the UI).

Currently allowing the following protocols:

• GET

2 End Point available.

• Get Document IDs

• Get Document By File ID

Document Types

• (All Types)

• ACH

• Budget

• Collection Reports

• Coupon File

• Data Export

• Group Reports

• Report

• Scheduled Reports

• Statement Files

• Uploaded Document

• Validation File

• Welcome Letter

Request URL

GET End Point

https://yourcustomerdatabase.cincsys.com/api/management/{mgmtId}/documentIds

Parameter Descriptions

• mgmtId (Management Id): Pass your management ID.

• startDate (Filter for Date range); Ability to filter by start date.

• endDate (Filter for Date range); Ability to filter by end date.

• type (File Type): File types listed out above.

Paramter Types

• mgmtId: string (required)

• startDate: datetime (required)

• endDate: datetime (required)

• type: string (required)

Response Body

The following shows example data being returned

[
  {
    "Description": string,
    "FileId": int
  },
]

[
  {
    "Description": "2020 Budget",
    "FileId": 22447
  },
  {
    "Description": "2021 Budget",
    "FileId": 22447
  },
]

Get Document/File

https://yourcustomerdatabase.cincsys.com/api/management/{mgmtId}/documents/{fileId}

Parameter Descriptions

• fileId (Management Id): Pass the file ID to be retrieved.

• mgmtId (Management Id): Pass your management ID.

Paramter Types

• fileId: string (required)

• mgmtId: string (required)

Returns a file object.

Response Codes

200 - OK Everything worked as expected.

400 - Bad Request: The request was unacceptable, often due to missing a required parameter.

401 - Unauthorized: No valid API key provided.

402 - Request Failed: The parameters were valid but the request failed.

403 - Forbidden: The API key does not have permission to perform the request.

404 - Not Found: The requested resource does not exist.