Skip to main content

Retrieves the active agreement by agreement code.

GET 
/Agreements/:code

Retrieves the active agreement by agreement code.

Request​

Path Parameters

    code stringrequired

    Agreement code

Query Parameters

    api-version string

Header Parameters

    X-Request-ID stringrequired

Responses​

Agreement details if found, otherwise an error response

Schema
    agreementCode stringnullablerequired

    Agreement code.

    agreementType stringnullablerequired

    Agreement title

    color stringnullablerequired

    Gets or sets the color associated with the agreement.

    agreementAmount decimalrequired

    AgreementAmount

    customers stringnullablerequired

    Customer.

    active booleannullablerequired

    If the agreement is active.

    dateUpdated date-timerequired

    Updated date of the agreement.

    loanTypes stringnullablerequired

    Loan types associated with the agreement.

Loading...