Billing
What CIS Manager charges the authenticated user, across every tenant they own (no tenant in the route): the billing profile (invoice address and mandate state), the direct debit mandate with its GoCardless setup (start a setup, send the customer to GoCardless, complete it), the invoices with their PDFs, and the usage not yet invoiced. Reads refresh the mandate and pending payments from GoCardless.
-
GET Get Billing ProfileThe caller's billing profile: the address their invoices are made out to and the state of their direct debit mandate. Empty (no address, mandate NotSt.../me/billing/profile
-
PUT Update Billing ProfileReplaces the caller's billing address (company name, billing email, address lines, postcode, country), creating the profile on first use. The mandate .../me/billing/profile
-
GET Get Billing MandateThe caller's direct debit mandate, its status refreshed from GoCardless (so a setup completed moments ago shows as it is, whether or not the webhook h.../me/billing/mandate
-
PUT Complete Mandate SetupCompletes a direct debit setup the customer has finished on GoCardless: the redirect flow id (from the setup, and appended by GoCardless to the succes.../me/billing/mandate
-
DELETE Cancel Billing MandateCancels the caller's direct debit mandate with GoCardless. Automatic payments stop; a new setup can be started at any time. 404 when there is no manda.../me/billing/mandate
-
POST Create Mandate SetupStarts a direct debit setup with GoCardless. Send the customer's browser to the returned redirectUrl; GoCardless sends it back to the successRedirectU.../me/billing/mandate-setups
-
GET List Billing UsageThe usage not yet invoiced, across every tenant the caller owns: each monthly return HMRC has accepted, with the subcontractors on it. Invoiced at the.../me/billing/usage
-
GET List Billing InvoicesThe caller's invoices from CIS Manager, latest first, with the payment status of any pending or failed ones refreshed from GoCardless first./me/billing/invoices
-
GET Get Billing InvoiceOne of the caller's invoices, with its lines. Another user's invoice is not found./me/billing/invoices/{invoice}
-
GET Get Billing Invoice PDFThe invoice as the PDF that was emailed. 404 when the invoice is not the caller's or its PDF has not been generated yet (hasPdf)./me/billing/invoices/{invoice}/pdf