Get Pay In Details | Thera API Docs

{
  "time": "2024-01-15T09:30:00Z",
  "status": "PENDING",
  "invoiceCount": 1,
  "invoices": [
    {
      "id": "id",
      "type": "INVOICE",
      "status": "OPEN",
      "wageType": "HOURLY",
      "contractType": "FIXED_RATE",
      "displayId": "displayId",
      "contractId": "contractId",
      "contractorFirstName": "contractorFirstName",
      "contractorLastName": "contractorLastName",
      "contractJobTitle": "contractJobTitle",
      "payInCurrency": "payInCurrency",
      "payInAmount": 1000000,
      "subscriptionFee": 1000000,
      "contractCurrency": "contractCurrency",
      "contractAmount": 1000000,
      "autoPaid": true,
      "startDate": "2023-01-15",
      "endDate": "2023-01-15",
      "date": "2023-01-15",
      "workUnitTotal": 1.1
    },
    {
      "id": "id",
      "type": "INVOICE",
      "status": "OPEN",
      "wageType": "HOURLY",
      "contractType": "FIXED_RATE",
      "displayId": "displayId",
      "contractId": "contractId",
      "contractorFirstName": "contractorFirstName",
      "contractorLastName": "contractorLastName",
      "contractJobTitle": "contractJobTitle",
      "payInCurrency": "payInCurrency",
      "payInAmount": 1000000,
      "subscriptionFee": 1000000,
      "contractCurrency": "contractCurrency",
      "contractAmount": 1000000,
      "autoPaid": true,
      "startDate": "2023-01-15",
      "endDate": "2023-01-15",
      "date": "2023-01-15",
      "workUnitTotal": 1.1
    }
  ],
  "currency": "currency",
  "total": 1000000,
  "invoicesTotal": 1000000,
  "subscriptionContractorCount": 1,
  "subscriptionFeePerContractor": 1000000,
  "subscriptionTotal": 1000000,
  "fixedFee": 1000000,
  "variableFee": 1000000,
  "variableFeeFraction": 1.1,
  "exchangeRates": {
    "exchangeRates": 1.1
  },
  "callingUserCanDelete": true,
  "paymentMethod": {
    "type": "ach",
    "accountNumber": "accountNumber"
  },
  "paymentMethodId": "paymentMethodId"
}

One pay-in, with the invoices it settled, the amount charged, and any fees on top.

Authentication

X-Thera-API-Keystring

API Key authentication via header

Path parameters

companyIdstringRequired

payInIdstringRequired

Response

This endpoint returns an object.

timedatetime

statusenum

Allowed values:

invoiceCountinteger

invoiceslist of objects

currencystring

totallong

invoicesTotallong

The total amount charged excluding any fees.

subscriptionContractorCountinteger

subscriptionFeePerContractorlong

subscriptionTotallong

fixedFeelong

variableFeelong

variableFeeFractiondouble

exchangeRatesmap from strings to doubles

callingUserCanDeleteboolean

True if the calling user has permission to delete this payment.

paymentMethodobjectOptional

paymentMethodIdstringOptional