finance

Offboard Customer Route

Stop billing a customer who cancelled, and stop routing their mail.

THIS IS THE ONLY WAY TO SAY A CUSTOMER LEFT. offboarding_records is described throughout the finance module as the sole authority that stops billing, and until this route existed nothing in v2 could write one -- every row came from the v1 import. Three cancelled customers were found on 2026-08-21 with no record at all, stopped only because their terms happened to be expired. Auto-renew had already minted one of them a fresh term for the following year.

ONE WRITE, TWO EFFECTS, because the same record is read by both: finance's invoice generator refuses to bill a period after the last billable day, and transcription refuses to route newly scanned mail to the facility (see transcription.service. assert_facility_still_takes scanned_mail). Baltimore County cost 1,373 parcels' worth of scanning, printing and shipping for want of exactly this.

finance:write: deciding a customer has left is the same authority as invoicing them.

post/api/finance/organizations/{org_id}/offboard

Request

  • Base URL: https://api.pigeonly.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pigeonly.com/api/finance/organizations/{org_id}/offboard
  • Auth: none declared

Path parameters

org_idstring uuid required

Request body

final_scan_datestring date nullable
cancellation_confirmed_datestring date nullable
facility_idstring uuid nullable

Response

Successful Response

object required

Changes

No recorded changes to this operation across all 1 revision of this API.