List financing agreements v2

​
Query Parameters
  • page
    Type: integer
    min:  
    -9007199254740991
    max:  
    9007199254740991

    Page number

  • limit
    Type: integer
    min:  
    -9007199254740991
    max:  
    9007199254740991

    Items per page

  • search
    Type: string

    Free-text search

  • dateFrom
    Type: string

    Filter from date (YYYY-MM-DD; legacy MM-DD-YYYY accepted)

  • dateTo
    Type: string

    Filter to date (YYYY-MM-DD; legacy MM-DD-YYYY accepted)

  • orderBy
    Type: string

    Field used for sorting

  • orderDirection
    enum

    Sort direction

    values
    • asc
    • desc
  • id
    Type: string Format: uuid

    Financing agreement UUID

  • customerId
    Type: string Format: uuid

    Customer UUID

  • externalId
    Type: string

    Partner-defined customer identifier

  • status
    enum

    Financing agreement status

    values
    • IN_PROGRESS
    • COMPLETED
    • DEFAULTED
    • RESTRUCTURED
  • creditLineId
    Type: string Format: uuid

    Only agreements that are draws of this credit line

  • hasCreditLine

    true = only credit line draws, false = only regular capital agreements. Ignored when creditLineId is set

    • Type: boolean

      true = only credit line draws, false = only regular capital agreements. Ignored when creditLineId is set

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/v2/financing-agreements
curl https://api-sandbox.tryslatehq.com/v2/financing-agreements \
  --header 'x-api-key: YOUR_SECRET_TOKEN'

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "applicationId": "123e4567-e89b-12d3-a456-426614174000",
      "creditLineId": "123e4567-e89b-12d3-a456-426614174000",
      "customerId": "123e4567-e89b-12d3-a456-426614174000",
      "fundedAmount": 10000,
      "fundedDate": "2025-01-01",
      "currency": "CAD",
      "firstPaymentDate": "2025-01-01",
      "estimatedLastPaymentDate": "2025-01-01",
      "status": "IN_PROGRESS",
      "term": 12,
      "termUnit": "month",
      "repaymentFrequency": 1,
      "repaymentFrequencyUnit": "month",
      "disbursed": false,
      "remainingBalance": 10000,
      "totalPaid": 10000,
      "createdAt": "2025-01-01T00:00:00Z",
      "updatedAt": "2025-01-01T00:00:00Z",
      "type": "fixed_mca",
      "fixedMCA": {
        "factorRate": 1.2
      }
    }
  ],
  "page": 1,
  "limit": 1,
  "total": 1,
  "totalPages": 1
}

OK