API Docs / Schemas / RemittanceAdviceDto

RemittanceAdviceDto

A remittance advice: what the tenant paid one subcontractor between two dates, invoice by invoice, with the
CIS deductions taken. Built from the payments when asked for, not stored.

Properties

Name Type Description
contact*string

The subcontractor (contact code)

The subcontractor (contact code)

contactName*string

The subcontractor's name

The subcontractor's name

contactEmailstring

The subcontractor's email address, the default recipient of the advice

The subcontractor's email address, the default recipient of the advice

contactAddressstring

The subcontractor's address, one line per row

The subcontractor's address, one line per row

contactUtrstring

The subcontractor's Unique Taxpayer Reference

The subcontractor's Unique Taxpayer Reference

contactIsVatRegistered*boolean

Whether the subcontractor is VAT registered

Whether the subcontractor is VAT registered

from*string

The first payment date covered

The first payment date covered

to*string

The last payment date covered

The last payment date covered

contractorName*string

The tenant's name, as the contractor

The tenant's name, as the contractor

contractorAddressstring

The tenant's address

The tenant's address

contractorEmployersReferencestring

The tenant's HMRC accounts office reference

The tenant's HMRC accounts office reference

totalGross*number

Paid plus deducted

Paid plus deducted

totalMaterials*number

The materials within the gross

The materials within the gross

totalLabour*number

The gross less materials

The gross less materials

totalDeduction*number

The CIS deducted

The CIS deducted

totalNet*number

The amount paid

The amount paid

totalVat*number

The VAT on the invoices covered

The VAT on the invoices covered

payments*array of RemittanceAdvicePaymentDto

The payments, one per invoice payment

The payments, one per invoice payment

deductionSummaries*array of RemittanceDeductionSummaryDto

The deductions summarised by the rate applied

The deductions summarised by the rate applied

JSON Example

{
  "contact": "string",
  "contactName": "string",
  "contactEmail": "string",
  "contactAddress": "string",
  "contactUtr": "string",
  "contactIsVatRegistered": false,
  "from": "2024-01-01T00:00:00Z",
  "to": "2024-01-01T00:00:00Z",
  "contractorName": "string",
  "totalGross": 0,
  "totalMaterials": 0,
  "totalLabour": 0,
  "totalDeduction": 0,
  "totalNet": 0,
  "totalVat": 0,
  "payments": [
    {
      "invoice": "...",
      "invoiceDate": "...",
      "yourReference": "...",
      "theirReference": "...",
      "date": "...",
      "amount": "...",
      "deduction": "...",
      "materials": "...",
      "total": "...",
      "isDomesticReverseCharge": "..."
    }
  ],
  "deductionSummaries": [
    {
      "taxStatus": "...",
      "amountLiableToDeduction": "...",
      "amountDeducted": "..."
    }
  ]
}

Used By Operations