API Docs / Schemas / BillingUsageDto

BillingUsageDto

Usage recorded for a tenant the caller owns: a monthly return accepted by HMRC and the subcontractors on it.

Properties

Name Type Description
tenantName*string

The tenant's name

The tenant's name

year*integer

The calendar year the tax month ends in

The calendar year the tax month ends in

month*integer

The calendar month the tax month ends in

The calendar month the tax month ends in

subcontractorCount*integer

The subcontractors on the return

The subcontractors on the return

previouslyBilledCountinteger

The subcontractors already invoiced for the month, when it was re-submitted

The subcontractors already invoiced for the month, when it was re-submitted

billableCount*integer

The subcontractors this record will be charged for

The subcontractors this record will be charged for

returnAcceptedDate*string

When HMRC accepted the return

When HMRC accepted the return

status*enum

Whether the usage has been invoiced

Pending Discarded Billed

Whether the usage has been invoiced

Pending Discarded Billed

billedDatestring

When it was invoiced

When it was invoiced

JSON Example

{
  "tenantName": "string",
  "year": 0,
  "month": 0,
  "subcontractorCount": 0,
  "previouslyBilledCount": 0,
  "billableCount": 0,
  "returnAcceptedDate": "2024-01-01T00:00:00Z",
  "status": "Pending"
}