Get Contractor Fees | Thera API Docs

{
  "companyId": "companyId",
  "fromMonth": "fromMonth",
  "toMonth": "toMonth",
  "totals": [
    {
      "amountMinor": 1000000,
      "currency": "currency"
    },
    {
      "amountMinor": 1000000,
      "currency": "currency"
    }
  ],
  "months": [
    {
      "month": "month",
      "contractorsCharged": 1,
      "employeesCharged": 1,
      "totals": [
        {
          "amountMinor": 1000000,
          "currency": "currency"
        },
        {
          "amountMinor": 1000000,
          "currency": "currency"
        }
      ]
    },
    {
      "month": "month",
      "contractorsCharged": 1,
      "employeesCharged": 1,
      "totals": [
        {
          "amountMinor": 1000000,
          "currency": "currency"
        },
        {
          "amountMinor": 1000000,
          "currency": "currency"
        }
      ]
    }
  ],
  "contractors": [
    {
      "id": "id",
      "invoicesPaid": 1,
      "charges": [
        {
          "month": "month",
          "amount": {
            "amountMinor": 1000000,
            "currency": "currency"
          },
          "chargedOn": "chargedOn",
          "paymentId": "paymentId",
          "billingMethod": "PAYMENT_RUN"
        },
        {
          "month": "month",
          "amount": {
            "amountMinor": 1000000,
            "currency": "currency"
          },
          "chargedOn": "chargedOn",
          "paymentId": "paymentId",
          "billingMethod": "PAYMENT_RUN"
        }
      ],
      "totals": [
        {
          "amountMinor": 1000000,
          "currency": "currency"
        },
        {
          "amountMinor": 1000000,
          "currency": "currency"
        }
      ],
      "name": "name",
      "email": "email"
    },
    {
      "id": "id",
      "invoicesPaid": 1,
      "charges": [
        {
          "month": "month",
          "amount": {
            "amountMinor": 1000000,
            "currency": "currency"
          },
          "chargedOn": "chargedOn",
          "paymentId": "paymentId",
          "billingMethod": "PAYMENT_RUN"
        },
        {
          "month": "month",
          "amount": {
            "amountMinor": 1000000,
            "currency": "currency"
          },
          "chargedOn": "chargedOn",
          "paymentId": "paymentId",
          "billingMethod": "PAYMENT_RUN"
        }
      ],
      "totals": [
        {
          "amountMinor": 1000000,
          "currency": "currency"
        },
        {
          "amountMinor": 1000000,
          "currency": "currency"
        }
      ],
      "name": "name",
      "email": "email"
    }
  ],
  "unattributedCharges": [
    {
      "month": "month",
      "contractorCount": 1,
      "amount": {
        "amountMinor": 1000000,
        "currency": "currency"
      },
      "chargedOn": "chargedOn",
      "paymentId": "paymentId"
    },
    {
      "month": "month",
      "contractorCount": 1,
      "amount": {
        "amountMinor": 1000000,
        "currency": "currency"
      },
      "chargedOn": "chargedOn",
      "paymentId": "paymentId"
    }
  ],
  "w2Charges": [
    {
      "month": "month",
      "chargedOn": "chargedOn",
      "paymentId": "paymentId",
      "amount": {
        "amountMinor": 1000000,
        "currency": "currency"
      },
      "employees": [
        {
          "id": "id",
          "name": "name",
          "email": "email"
        },
        {
          "id": "id",
          "name": "name",
          "email": "email"
        }
      ],
      "employeeCount": 1,
      "companyFee": {
        "amountMinor": 1000000,
        "currency": "currency"
      },
      "perEmployeeFee": {
        "amountMinor": 1000000,
        "currency": "currency"
      }
    },
    {
      "month": "month",
      "chargedOn": "chargedOn",
      "paymentId": "paymentId",
      "amount": {
        "amountMinor": 1000000,
        "currency": "currency"
      },
      "employees": [
        {
          "id": "id",
          "name": "name",
          "email": "email"
        },
        {
          "id": "id",
          "name": "name",
          "email": "email"
        }
      ],
      "employeeCount": 1,
      "companyFee": {
        "amountMinor": 1000000,
        "currency": "currency"
      },
      "perEmployeeFee": {
        "amountMinor": 1000000,
        "currency": "currency"
      }
    }
  ]
}

The contractor and US payroll subscription fees a company was charged for a range of months. Each fee is filed under the month it covered, which is not always the month it was charged in.

Authentication

X-Thera-API-Keystring

API Key authentication via header

Path parameters

companyIdstringRequired

Query parameters

fromMonthstringRequired

First month of the range, as YYYY-MM, within the last 36 months counting the current one.

toMonthstringRequired

Last month of the range, inclusive, as YYYY-MM. The range spans at most 12 months counting both ends, and cannot end in the future.

Response

This endpoint returns an object.

companyIdstring

fromMonthstring

toMonthstring

totalslist of objects

Every contractor and US payroll fee in the range, one entry per currency.

monthslist of objects

contractorslist of objects

unattributedChargeslist of objects

w2Chargeslist of objects

US payroll subscription charges in the range, oldest first. Part of the totals.