API GuideAccounting APIInsights API
v1.1.1009
OAS 3.0.3

Kravia Data Api

Development

Client Libraries
Curl Shell

Cohort invoices

​
Cohort invoices Operations

/api/cohort/invoices/recovery

​
Query Parameters
  • metrics
    Type:array string[] enum
    • capital
    • capitalPaidDirectly
    • capitalCollected
    • capitalRefunded
    • provision
    • interest
    • fees
    • courtFees
  • calculation
    Type:string enum
    • sum
    • avg
    • count
  • fromDate
    Type:string Format: date

    full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

  • toDate
    Type:string Format: date

    full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

  • creditors
    Type:array integer[]
  • excludeCreditors
    Type:boolean
    default: 
    false
  • workspaces
    Type:array integer[]
  • excludeWorkspaces
    Type:boolean
    default: 
    false
  • countries
    Type:array string[]
  • excludeCountries
    Type:boolean
    default: 
    false
  • departments
    Type:array integer[]
  • excludeDepartments
    Type:boolean
    default: 
    false
  • timeReference
    Type:string enum
    • collectionFeeDate
    • courtResponseDate
    • collectionEndedDate
    • startMonth
  • isPrivate
    Type:boolean
  • isInvoice
    Type:boolean
  • isReminder
    Type:boolean
  • isCollectionCase
    Type:boolean
  • accountingSystem
    Type:array string[]
  • minAgeInMonths
    Type:integer

    Integer numbers.

  • maxAgeInMonths
    Type:integer

    Integer numbers.

  • recoveryThreshold
    Type:number
  • isLegalCase
    Type:boolean
  • sortOrder
    Type:array string[] enum
    • startMonth
    • collectionFeeMonth
    • collectionEndedMonth
    • isPrivate
    • accountingSystem
  • absoluteTimeReference
    Type:boolean
  • cohortDefinition
    Type:array string[] enum
    • startMonth
    • collectionFeeMonth
    • collectionEndedMonth
    • isPrivate
    • accountingSystem
Responses
  • application/json
Request Example forGET/api/cohort/invoices/recovery
curl https://data-api-qa.kravia.ai/api/cohort/invoices/recovery \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "data": {
    "cohorts": [
      {
        "metrics": [
          {
            "calculation": "sum",
            "reference": {
              "ANY_ADDITIONAL_PROPERTY": 1
            },
            "sample": {
              "ANY_ADDITIONAL_PROPERTY": 1
            },
            "type": [
              "…"
            ]
          }
        ],
        "parameters": [
          {
            "type": [
              "startMonth"
            ],
            "value": "…"
          }
        ]
      }
    ],
    "definition": [
      "startMonth"
    ]
  },
  "error": "…",
  "success": true
}

CohortResponse(success: bool = None, error: str = None, data: lib.models.cohort.RecoveryCycleSummary = None)

Creditors (Collapsed)

​
Creditors Operations

Debt statistics (Collapsed)

​
Debt statistics Operations

Models