== LOAN PURPOSES

The Loan purposes resource is used to list, create, and update loan purposes.

=== Retrieve a loan purpose

A `GET` request will retrieve the details of a loan purpose.

==== Response fields

include::{snippets}/loan-purpose-get-example/response-fields.adoc[]

==== Example request

include::{snippets}/loan-purpose-get-example/http-request.adoc[]

==== Example response

include::{snippets}/loan-purpose-get-example/http-response.adoc[]

=== Create a loan purpose

A `POST` request will create a new loan purpose.

==== Request fields

include::{snippets}/loan-purpose-create-example/request-fields.adoc[]

==== Response fields

include::{snippets}/loan-purpose-create-example/response-fields.adoc[]

==== Example request

include::{snippets}/loan-purpose-create-example/http-request.adoc[]

==== Example response

include::{snippets}/loan-purpose-create-example/http-response.adoc[]

=== Create children for a loan purpose

A `POST` request will create a loan purpose.

include::{snippets}/loan-purpose-children-create-example/request-fields.adoc[]

==== Response fields

include::{snippets}/loan-purpose-children-create-example/response-fields.adoc[]

==== Example request

include::{snippets}/loan-purpose-children-create-example/http-request.adoc[]

==== Example response

include::{snippets}/loan-purpose-children-create-example/http-response.adoc[]

=== Update a loan purpose

A `PUT` request will update the details of a loan purpose.

==== Request fields

include::{snippets}/loan-purpose-update-example/request-fields.adoc[]

==== Response fields

include::{snippets}/loan-purpose-update-example/response-fields.adoc[]

==== Example request

include::{snippets}/loan-purpose-update-example/http-request.adoc[]

==== Example response

include::{snippets}/loan-purpose-update-example/http-response.adoc[]

=== Retrieve a loan purpose lookup

A `GET` request will retrieve the details of a loan purpose lookup.

==== Response fields

include::{snippets}/loan-purpose-get-lookup-example/response-fields.adoc[]

==== Example request

include::{snippets}/loan-purpose-get-lookup-example/http-request.adoc[]

==== Example response

include::{snippets}/loan-purpose-get-lookup-example/http-response.adoc[]