# Close out a schedule

Marks a schedule finished: it stops collecting, the end date is stamped today and the next payment date is cleared. No body. Legal from active, paused or defaulted — completing an already finished or cancelled schedule means nothing and answers not found. This records that collection is OVER; how the deal ended in money terms — paid in full, an early payoff, a write-off, a settlement — is `post_servicing_outcomes`.

Access class: `workspace`.

## Endpoint

`POST /v1/payment-schedules/{id}/complete`

## Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| id | path | string | Yes |

## Request body

Content type: `application/json`.

```json
{
  "body": {},
  "params": {
    ":id": "string"
  },
  "query": {}
}
```

## Responses

### 201

the action's answer

Content type: `application/json`.

```json
{
  "data": {
    "actualEndDate": "string",
    "collectionRate": "string",
    "completedAt": "string",
    "consecutiveMissed": 1,
    "contractId": 1,
    "createdAt": "string",
    "currency": "string",
    "daysDelinquent": 1,
    "dealRowId": "",
    "detail": {},
    "expectedEndDate": "string",
    "facilityId": 1,
    "factorRate": "string",
    "fundedAmountMinor": 1,
    "fundingRecordId": 1,
    "id": 1,
    "interestRate": "string",
    "internalNotes": "string",
    "isDelinquent": true,
    "lastModifiedReason": "string",
    "modificationsCount": 1,
    "nextPaymentDate": "string",
    "offerId": 1,
    "originationFeeMinor": 1,
    "otherFeesMinor": 1,
    "pausedAt": "string",
    "paymentAmountMinor": 1,
    "paymentFrequency": "string",
    "paymentMethod": "string",
    "paymentsMade": 1,
    "paymentsRemaining": 1,
    "paymentsWaived": 1,
    "scheduleNumber": "string",
    "startDate": "string",
    "status": "string",
    "totalCollectedMinor": 1,
    "totalMissedMinor": 1,
    "totalOutstandingMinor": 1,
    "totalPaybackMinor": 1,
    "totalPayments": 1,
    "updatedAt": "string"
  }
}
```

### default

a refusal: `{"error": "<what a person needs to read>"}`. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

Content type: `application/json`.

```json
{
  "error": "string"
}
```