> For the complete documentation index, see [llms.txt](https://guide.fariaedu.com/integrations-portal/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://guide.fariaedu.com/integrations-portal/openapply/public-rest-apis/v3/fees.md).

# Fees

This page describes all the APIs relating to fees.

## Get all Fees

> Retrieves a list of all fees. Results are paginated.\
> Use the \`page\` and \`per\_page\` query parameters to control pagination.<br>

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"tags":[{"name":"Fees","description":"This page describes all the APIs relating to fees."}],"servers":[{"url":"https://api.openapply.com","description":"CAN region auth server"},{"url":"https://api.openapply.cn","description":"CN region auth server"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/api/v3/fees":{"get":{"summary":"Get all Fees","tags":["Fees"],"operationId":"listFees","description":"Retrieves a list of all fees. Results are paginated.\nUse the `page` and `per_page` query parameters to control pagination.\n","parameters":[{"name":"since_date","in":"query","required":false,"description":"Return results updated since the specified date, in UTC timezone","schema":{"type":"string","format":"date_time"}},{"name":"issue_date","in":"query","schema":{"type":"string"}},{"name":"status","in":"query","schema":{"type":"string"}},{"name":"status_level","in":"query","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"The page number of results to return.","schema":{"type":"integer","minimum":1,"default":1}},{"name":"per_page","in":"query","required":false,"description":"Request for how many records to return.","schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"count","in":"query","required":false,"description":"Synonym for per_page","schema":{"type":"integer"}}],"responses":{"200":{"description":"successful","content":{"application/json":{}}},"400":{"description":"bad request","content":{"application/json":{}}},"422":{"description":"unprocessable content","content":{"application/json":{}}}}}}}}
```

## Create a Fee for a Student

> Create a fee. Returns the unique \`id\` in the body as well as attributes if successful.<br>

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"tags":[{"name":"Fees","description":"This page describes all the APIs relating to fees."}],"servers":[{"url":"https://api.openapply.com","description":"CAN region auth server"},{"url":"https://api.openapply.cn","description":"CN region auth server"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/api/v3/students/{id}/fees":{"post":{"summary":"Create a Fee for a Student","tags":["Fees"],"operationId":"createFee","description":"Create a fee. Returns the unique `id` in the body as well as attributes if successful.\n","parameters":[{"name":"id","in":"path","required":true,"description":"Serial database ID used to refer to a unique student record in OpenApply","schema":{"type":"integer"}}],"responses":{"201":{"description":"created paid fee","content":{"application/json":{}}},"404":{"description":"Fee template not found","content":{"application/json":{}}},"422":{"description":"Invalid params","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"custom_fee_id":{"type":"integer","description":"The database id of the asscociated fee template"},"status":{"type":"string","enum":["outstanding","processing","paid","past_due","refunded"]},"payment_date":{"type":"string","format":"date"},"payment_method":{"type":"string"},"payment_reminder_sent_at":{"type":"string"},"check_number":{"type":"string"},"last4":{"type":"string"}},"required":["custom_fee_id"]}}}}}}}}
```

## Update a Fee

> Fetch an instance of a fee<br>

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"tags":[{"name":"Fees","description":"This page describes all the APIs relating to fees."}],"servers":[{"url":"https://api.openapply.com","description":"CAN region auth server"},{"url":"https://api.openapply.cn","description":"CN region auth server"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/api/v3/students/{id}/fees/{fee_id}":{"patch":{"summary":"Update a Fee","tags":["Fees"],"operationId":"updateFee","parameters":[{"name":"id","in":"path","required":true,"description":"Serial database ID used to refer to a unique student record in OpenApply","schema":{"type":"integer"}},{"name":"fee_id","in":"path","description":"Serial database ID that uniquely identifies a fee record in OpenApply","required":true,"schema":{"type":"integer"}}],"description":"Fetch an instance of a fee\n","responses":{"200":{"description":"successful","content":{"application/json":{}}},"400":{"description":"Empty payload is not allowed","content":{"application/json":{}}},"404":{"description":"Fee not found","content":{"application/json":{}}},"422":{"description":"Invalid date","content":{"application/json":{}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"amount":{"type":"integer"},"issue_date":{"type":"string"},"due_date":{"type":"string"},"currency":{"type":"string"}}}}}}}}}}
```

## Get all Payments

> Synconym for "Get all Fees". Included to ensure backward compatibility. Please use "Get all Fees" instead

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"tags":[{"name":"Fees","description":"This page describes all the APIs relating to fees."}],"servers":[{"url":"https://api.openapply.com","description":"CAN region auth server"},{"url":"https://api.openapply.cn","description":"CN region auth server"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/api/v3/payments":{"get":{"summary":"Get all Payments","tags":["Fees"],"operationId":"listPayments","description":"Synconym for \"Get all Fees\". Included to ensure backward compatibility. Please use \"Get all Fees\" instead","deprecated":true,"parameters":[{"name":"since_date","in":"query","required":false,"description":"Return results updated since the specified date, in UTC timezone","schema":{"type":"string","format":"date_time"}},{"name":"issue_date","in":"query","schema":{"type":"string"}},{"name":"status","in":"query","schema":{"type":"string"}},{"name":"status_level","in":"query","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"The page number of results to return.","schema":{"type":"integer","minimum":1,"default":1}},{"name":"per_page","in":"query","required":false,"description":"Request for how many records to return.","schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"count","in":"query","required":false,"description":"Synonym for per_page","schema":{"type":"integer"}}],"responses":{"200":{"description":"successful","content":{"application/json":{}}},"400":{"description":"bad request","content":{"application/json":{}}},"422":{"description":"unprocessable content","content":{"application/json":{}}}}}}}}
```

## GET /api/v3/fees/templates

> Get all Fee Templates

```json
{"openapi":"3.0.1","info":{"title":"openapply","version":"3.0.0"},"tags":[{"name":"Fees","description":"This page describes all the APIs relating to fees."}],"servers":[{"url":"https://api.openapply.com","description":"CAN region auth server"},{"url":"https://api.openapply.cn","description":"CN region auth server"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/api/v3/fees/templates":{"get":{"summary":"Get all Fee Templates","tags":["Fees"],"operationId":"listFeeTemplates","responses":{"200":{"description":"successful","content":{"application/json":{}}}}}}}}
```