- AddressDtoA postal address.
- BillingInvoiceDto1 endpointA CIS Manager invoice to the caller for their usage.
- BillingInvoiceLineDtoOne line of a CIS Manager invoice: a tenant's subcontractors on one monthly return.
- BillingMandateDto2 endpointsThe caller's direct debit mandate, refreshed from GoCardless.
- BillingProfileDto2 endpointsThe caller's billing profile: the address their invoices are made out to and the state of their dire...
- BillingUsageDtoUsage recorded for a tenant the caller owns: a monthly return accepted by HMRC and the subcontractor...
- BulkHmrcVerificationRequest1 endpointAsks HMRC to verify or match several subcontractors at once.
- BulkHmrcVerificationResultDto1 endpointThe outcome of a bulk HMRC verification request: which contacts were sent to HMRC and which were not...
- CisDetailsDtoThe subcontractor's CIS identity: what HMRC verifies them by. The verification outcome (status, veri...
- CompleteMandateSetupRequest1 endpointCompletes a direct debit setup the customer has finished on GoCardless (`PUT /me/billing/mandate`).
- ConnectionCisDetailsDtoThe CIS identity a subcontractor tenant shares over a connection.
- ConnectionDto3 endpointsA connection between two CIS Manager tenants (an "Interlink"), seen from the viewing tenant's side. ...
- ConnectionPartyDtoThe other tenant on a connection.
- ContactDto3 endpointsA contact: a person or organisation the tenant does business with, in one or more roles. Customers a...
- ContactDtoPagedResult1 endpoint
- ContactImportResultDto1 endpointThe outcome of a subcontractor import.
- ContactImportResultRowDtoThe outcome of importing one selected row.
- ContactImportRowDtoOne data row of a subcontractor import CSV as the analysis sees it: the contact it would become, or ...
- ContactInvoicingDtoA contact's invoicing summaries, one per direction. Read-only; maintained by the invoice resources.
- ContactNoteDto3 endpointsA free-text note recorded against a contact.
- ContactNoteDtoPagedResult1 endpoint
- CreateConnectionRequest1 endpointA new connection, initiated by the tenant for one of its contacts.
- CreateContactNoteRequest1 endpointA new note for a contact.
- CreateContactRequest1 endpointCreates a contact. The code is generated from the display name. The role-specific parts may be omitt...
- CreateHmrcCredentialsRequest1 endpointNew shared credentials.
- CreateInvitationRequest1 endpointA new invitation. It is emailed at once and expires after seven days.
- CreateInvoiceLineRequestA line of a new invoice.
- CreateInvoicePaymentRequest2 endpointsA new payment against an invoice.
- CreateInvoiceRequest2 endpointsA new invoice.
- CreateMandateSetupRequest1 endpointStarts a direct debit setup (`POST /me/billing/mandate-setups`).
- CreateMonthlyReturnRequest1 endpointA new monthly return for a tax month.
- CreateSdcStatementRequest1 endpointA new SDC statement. Creating it emails the subcontractor a link to complete it.
- CreateTenantRequest1 endpointA new tenant, owned by the caller. Its email address and phone number start as the caller's.
- EmailMessageDto3 endpointsAn email sent of a document (an invoice, a remittance advice) to a contact, with its delivery status...
- EmailSettingsDto2 endpointsThe tenant's email settings: the signature appended to every email it sends and whether statements g...
- EmailTemplateDto3 endpointsOne of the tenant's email templates: the subject and body in use (the defaults until customised) and...
- EnumMetadata
- HmrcAgentDtoThe agent details sent with a submission when the sender is an agent.
- HmrcContactDtoA person HMRC can contact about a submission.
- HmrcCredentialsDto3 endpointsA set of HMRC gateway credentials the caller owns and can share across the tenants they manage. The ...
- HmrcCredentialsTestResultDto2 endpointsThe outcome of a credentials test against the HMRC gateway.
- HmrcError
- HmrcSettingsDto2 endpointsThe tenant's HMRC gateway settings for CIS submissions. The gateway password is never returned: hasP...
- HmrcVerificationRequest1 endpointAsks HMRC to verify or match a subcontractor.
- HmrcVerificationRequestDtoA subcontractor's latest HMRC verification request. Requests are asynchronous: the API submits them ...
- HttpValidationProblemDetails78 endpoints
- InvoiceDto6 endpointsAn invoice: a purchase invoice received from a supplier or subcontractor (the tenant pays it), or a ...
- InvoiceDtoPagedResult2 endpoints
- InvoiceLineDtoA line of an invoice: labour or materials.
- InvoicePaymentDto6 endpointsA payment recorded against an invoice.
- InvoicingSummaryDto2 endpointsA summary of the invoices in one direction, a tenant's or one contact's: count, total, what is still...
- MandateSetupDto1 endpointA started direct debit setup: where to send the customer, and what the client must hold to complete ...
- MeDto2 endpointsThe authenticated user: profile, application roles and the tenants they belong to. The same whicheve...
- MonthAnalysisDtoOne month of invoicing activity, with the month before it for comparison.
- MonthlyReturnDto4 endpointsA CIS monthly return (CIS300): the payments made to subcontractors in one tax month (the 6th to the ...
- MonthlyReturnDtoPagedResult1 endpoint
- MonthlyReturnSubmissionDto1 endpointThe latest submission of a monthly return to HMRC.
- PaymentDateDtoThe payments made on one date, summarised.
- PaymentDtoA payment of any invoice of a direction, with the invoice and contact it belongs to.
- ProblemDetails374 endpoints
- PublicSdcStatementDto2 endpointsAn SDC statement as the subcontractor sees it on the public completion page, reached through the lin...
- RemittanceAdviceDto1 endpointA remittance advice: what the tenant paid one subcontractor between two dates, invoice by invoice, w...
- RemittanceAdvicePaymentDtoOne payment on a remittance advice.
- RemittanceAdviceSettingsDto2 endpointsHow the tenant's remittance advices are laid out: which columns they show and the custom texts they ...
- RemittanceDeductionSummaryDtoThe deductions on a remittance advice at one CIS rate.
- SdcStatementDto3 endpointsA Supervision, Direction and Control (SDC) statement: a questionnaire the tenant sends a subcontract...
- SendEmailRequest3 endpointsA request to email a document. Every field is optional: the recipient defaults to the contact's emai...
- SendSdcStatementEmailRequest1 endpointA request to send (or resend) the completion link for a statement.
- SendStatementEmailRequest2 endpointsA request to email a statement's PDF. Every field is optional: the recipient defaults to the subcont...
- SetConnectionCounterPartyRequest1 endpointThe accepting tenant's side of a connection sent to it.
- SignSdcStatementRequest1 endpointThe subcontractor's completion of an SDC statement: every question confirmed, their name and their s...
- SkippedHmrcVerificationDtoA contact a bulk HMRC verification request did not send.
- StatementDto2 endpointsA CIS payment and deduction statement: what one subcontractor was paid and had deducted in one tax m...
- StatementEmailDto2 endpointsAn email of a statement's PDF to the subcontractor.
- SubcontractorBreakdownRowDtoOne subcontractor's share of a monthly return (a subcontractor paid at two rates in the month appear...
- SubcontractorVerificationDto3 endpointsThe subcontractor's current CIS verification. On a contact it is read-only: it changes through the c...
- SubmitMonthlyReturnRequest1 endpointThe declarations made when submitting a return to HMRC. That the information is correct is always de...
- SupplierSettingsDtoDefaults applied to invoices received from a supplier (CIS subcontractors included).
- TenantAddressDtoA tenant's postal address: three free-text lines, as HMRC's contractor record holds it.
- TenantCisDetailsDto2 endpointsThe tenant's own CIS identity as a subcontractor: what it shares with contractors over a connection ...
- TenantCountsDtoA tenant's entity counts, maintained by the application as records are created and deleted.
- TenantDto5 endpointsA tenant: a CIS Manager organisation the caller is a member of. What the application needs on every ...
- TenantDtoPagedResult1 endpoint
- TenantInvitationDto2 endpointsAn invitation to join the tenant.
- TenantMemberDtoA user who is a member of the tenant.
- TenantMembershipDto1 endpointOne of the authenticated user's tenant memberships, as reported by `GET /me`.
- TenantSummaryDtoOne of the caller's tenants as the overview page shows them: counts and the returns of this and the ...
- TestHmrcCredentialsRequest1 endpointA request to test shared credentials against the HMRC gateway. A submission needs a tenant as its co...
- TimesheetImportResultDto1 endpointThe outcome of a timesheet import.
- TimesheetImportResultRowDtoThe outcome of importing one selected row.
- TimesheetImportRowDtoOne data row of a timesheet CSV as the analysis sees it: the purchase invoice it would become, or wh...
- TransferOwnershipRequest1 endpointThe member to make the tenant's owner.
- UpdateBillingProfileRequest1 endpointThe billing address to put on the caller's invoices (`PUT /me/billing/profile`). A full replacement ...
- UpdateContactNoteRequest1 endpointA full replacement of a note's text and date.
- UpdateContactRequest1 endpointReplaces a contact's editable fields, roles included. The code, external id, last SDC date and verif...
- UpdateEmailSettingsRequest1 endpointA full replacement of the email settings.
- UpdateEmailTemplateRequest1 endpointA customised subject and body for a template. DELETE the template to go back to the defaults.
- UpdateHmrcCredentialsRequest1 endpointA full replacement of shared credentials. The password is optional: omitted or null keeps the stored...
- UpdateHmrcSettingsRequest1 endpointA full replacement of the HMRC settings. The password is optional: omitted or null keeps the stored ...
- UpdateInvoiceLineRequestA line of an invoice being replaced: with the code of an existing line it updates that line, without...
- UpdateInvoicePaymentRequest2 endpointsA full replacement of a payment's date and amount.
- UpdateInvoiceRequest2 endpointsA full replacement of an invoice's editable fields and lines. The contact, external id and payments ...
- UpdateMeRequest1 endpointA full replacement of the caller's editable profile fields.
- UpdateRemittanceAdviceSettingsRequest1 endpointA full replacement of the remittance advice settings. A text whose switch is off is discarded.
- UpdateSubcontractorVerificationRequest1 endpointA verification obtained from HMRC outside the API (by phone or through HMRC online services), record...
- UpdateTenantCisDetailsRequest1 endpointA full replacement of the tenant's CIS details.
- UpdateTenantRequest1 endpointA full replacement of the tenant's own details, as the settings page edits them. Counts, the logo, t...
- UserInvitationDto1 endpointAn invitation to join a tenant, as the invited user sees it. The code is the one in the emailed link...
- VerifyEmailAddressRequest1 endpointThe address and key from an emailed verification link.