Get Pay in History

GET

/companies/:companyId/pay-ins

GET

/companies/:companyId/pay-ins

curl https://api.getthera.com/companies/companyId/pay-ins \
     -H "X-Thera-API-Key: <apiKey>"

200Retrieved

{
  "history": [
    {
      "id": "id",
      "status": "PENDING",
      "time": "2024-01-15T09:30:00Z",
      "invoiceCount": 1,
      "currency": "currency",
      "total": 1000000,
      "autoPaid": true,
      "offPlatformReference": "offPlatformReference"
    },
    {
      "id": "id",
      "status": "PENDING",
      "time": "2024-01-15T09:30:00Z",
      "invoiceCount": 1,
      "currency": "currency",
      "total": 1000000,
      "autoPaid": true,
      "offPlatformReference": "offPlatformReference"
    }
  ],
  "payments": [
    {
      "paymentId": "paymentId",
      "time": "2024-01-15T09:30:00Z",
      "totalAmount": 1000000,
      "currency": "currency",
      "status": "PENDING",
      "detail": {
        "type": "invoicePayment",
        "invoiceCount": 1,
        "subscriptionFee": 1000000,
        "offPlatformReference": "offPlatformReference"
      },
      "autoPaid": true
    },
    {
      "paymentId": "paymentId",
      "time": "2024-01-15T09:30:00Z",
      "totalAmount": 1000000,
      "currency": "currency",
      "status": "PENDING",
      "detail": {
        "type": "invoicePayment",
        "invoiceCount": 1,
        "subscriptionFee": 1000000,
        "offPlatformReference": "offPlatformReference"
      },
      "autoPaid": true
    }
  ],
  "nextCursor": "nextCursor"
}

Money the company has sent to Thera. Narrow by status, or to off-platform transfers only, and walk the pages with afterCursor. You only see pay-ins covering contracts you have permission to view.

Authentication

X-Thera-API-Keystring

API Key authentication via header

Path parameters

companyIdstringRequired

Query parameters

statusenumOptional

Allowed values:

offPlatformOnlybooleanOptional

pageSizelongOptional

afterCursorstringOptional

startDatestringOptional

Only pay-ins effective on or after this date (inclusive, format: YYYY-MM-DD)

endDatestringOptional

Only pay-ins effective on or before this date (inclusive, format: YYYY-MM-DD)

Response

This endpoint returns an object.

historylist of objects

Deprecated, please don't use anymore, will be removed next release!

paymentslist of objects

nextCursorstringOptional