---
updatedAt: 2026-05-28T11:38:46.000Z
agentTools:
  projectIndex: https://developer.sivo.com/llms.txt
---

# Report on Loan

Create a report entry for a loan, or update an existing report if it exists.

The Report API is used to provide details about transactions (disbursements, payments, etc.) associated with your loans. Sivo uses this information to calculate key performance indicators for your portfolio. It is important to provide the full history for every loan, starting from when they were originated.

For  report on loans defined as *Term Loans* `credit_type='term_loan'` is important to report the scheduled payments to get a better support for KPI.

It is very important to use the appropriate value to identify the `type` of the transaction:

* **disbursement**: indicates funds that were provided to the borrower and which increase the loan principal balance. For installment loans, a disbursement transaction with the loan amount should be provided when the loan is originated. Installment loans with multiple disbursements and revolving loans should send multiple disbursement transactions.
* **principal**: indicates a loan repayment that is applied to the loan principal. This should not include any income like interest or fees... separate transactions should be sent for those.
* **interest**: indicates an interest charge applied to the loan
* **origination\_fee**: origination fees charged when the loan is created
* **periodic\_fee**: non-interest fees applied on a recurring basis
* **late\_fee**: fees charge to the borrower due to late payments
* **refund**: a full or partial refund to the borrower. This offsets disbursements and impacts principal.
* **other**: other types of fees associated with the loan. Use the description property to provide any additional details.

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Banking",
    "description": "SIVO public Api REST",
    "version": "0.0.1"
  },
  "x-amazon-apigateway-api-key-source": "AUTHORIZER",
  "servers": [
    {
      "url": "https://dev.sivo.com/v1",
      "description": "Sandbox server (user test data)"
    }
  ],
  "paths": {
    "/reports": {
      "post": {
        "summary": "Report on Loan",
        "description": "Create a report entry for a loan, or update an existing report if it exists.",
        "operationId": "postReport",
        "tags": [
          "Payments and Disbursements"
        ],
        "requestBody": {
          "description": "Create a report",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/report"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/savedReport"
                }
              }
            }
          },
          "405": {
            "description": "Invalid input"
          }
        },
        "security": [
          {
            "prod-sandbox-sivo-api-authorizer": [
              "aws.cognito.signin.user.admin"
            ]
          }
        ],
        "x-amazon-apigateway-integration": {
          "httpMethod": "POST",
          "type": "AWS_PROXY",
          "uri": "arn:aws:apigateway:us-east-2:lambda:path/2015-03-31/functions/${Token[TOKEN.2317]}:Alias/invocations"
        }
      }
    }
  },
  "components": {
    "schemas": {
      "moneyAmount": {
        "type": "integer",
        "description": "See [Money](https://developer.sivo.com/reference/money) for details"
      },
      "text": {
        "type": "string",
        "minLength": 1
      },
      "dateTimeIso8601": {
        "type": "string",
        "description": "See [Dates and Times](https://developer.sivo.com/reference/dates-and-times) for details",
        "format": "date-time"
      },
      "dateIso8601": {
        "type": "string",
        "description": "See [Dates and Times](https://developer.sivo.com/reference/dates-and-times) for details",
        "format": "date"
      },
      "reportType": {
        "type": "string",
        "enum": [
          "disbursement",
          "interest",
          "late_fee",
          "origination_fee",
          "periodic_fee",
          "principal",
          "refund",
          "other"
        ]
      },
      "loanStatus": {
        "type": "string",
        "enum": [
          "active",
          "closed"
        ]
      },
      "report": {
        "type": "object",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/text",
            "description": ""
          },
          "loan_id": {
            "$ref": "#/components/schemas/text",
            "description": "The loan associated with this report."
          },
          "date": {
            "$ref": "#/components/schemas/dateIso8601",
            "description": "Date on which the transaction occurred. See [Dates and Times](https://developer.sivo.com/reference/dates-and-times) for details"
          },
          "amount": {
            "$ref": "#/components/schemas/moneyAmountPositive",
            "description": "Amount for the transaction. See [Money](https://developer.sivo.com/reference/money) for details. Must be greater than 0."
          },
          "balance": {
            "$ref": "#/components/schemas/moneyAmount",
            "description": "Loan balance including amount in this transaction. See [Money](https://developer.sivo.com/reference/money) for details"
          },
          "type": {
            "$ref": "#/components/schemas/reportType",
            "description": "Type of this transaction"
          },
          "loan_status": {
            "$ref": "#/components/schemas/loanStatus",
            "description": "Status of the loan at the time that this transaction occurred"
          },
          "description": {
            "$ref": "#/components/schemas/text",
            "description": "Description associated with this transaction."
          }
        },
        "required": [
          "id",
          "loan_id",
          "date",
          "amount",
          "balance",
          "type",
          "loan_status"
        ],
        "additionalProperties": false
      },
      "moneyAmountPositive": {
        "type": "integer",
        "description": "See [Money](https://developer.sivo.com/reference/money) for details. Must be greater than 0.",
        "minimum": 0
      },
      "savedReport": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "created_at": {
            "$ref": "#/components/schemas/dateTimeIso8601"
          },
          "updated_at": {
            "$ref": "#/components/schemas/dateTimeIso8601"
          },
          "id": {
            "$ref": "#/components/schemas/text",
            "description": ""
          },
          "loan_id": {
            "$ref": "#/components/schemas/text",
            "description": "The loan associated with this report."
          },
          "date": {
            "$ref": "#/components/schemas/dateIso8601",
            "description": "Date on which the transaction occurred. See [Dates and Times](https://developer.sivo.com/reference/dates-and-times) for details"
          },
          "amount": {
            "$ref": "#/components/schemas/moneyAmountPositive",
            "description": "Amount for the transaction. See [Money](https://developer.sivo.com/reference/money) for details. Must be greater than 0."
          },
          "balance": {
            "$ref": "#/components/schemas/moneyAmount",
            "description": "Loan balance including amount in this transaction. See [Money](https://developer.sivo.com/reference/money) for details"
          },
          "type": {
            "$ref": "#/components/schemas/reportType",
            "description": "Type of this transaction"
          },
          "loan_status": {
            "$ref": "#/components/schemas/loanStatus",
            "description": "Status of the loan at the time that this transaction occurred"
          },
          "description": {
            "$ref": "#/components/schemas/text",
            "description": "Description associated with this transaction."
          }
        },
        "required": [
          "amount",
          "balance",
          "created_at",
          "date",
          "id",
          "loan_id",
          "loan_status",
          "type",
          "updated_at"
        ]
      }
    },
    "securitySchemes": {
      "prod-sandbox-sivo-api-authorizer": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "x-amazon-apigateway-authtype": "cognito_user_pools",
        "x-amazon-apigateway-authorizer": {
          "type": "cognito_user_pools",
          "providerARNs": [
            "${Token[TOKEN.1762]}"
          ]
        }
      }
    }
  },
  "x-amazon-apigateway-minimum-compression-size": 0
}
```