/bff/document/change-customer

Repoints the invoice to a different customer contact within the same organisation, then (by default) regenerates the PDF from the current invoice description. Refuses to run on snapshot-locked invoices — customer identity is legally immutable once snapshotted.

InvoicepostBffDocumentChange-customer

Parameters

JSON body

Request body

application/json

idstringRequired

External invoice ID.

ExampleaB3xKm9pQ2wLn4Yz

customerIdstringRequired

External ID of the new customer contact (CuRefNo).

ExampleaHRj9aHo9cXcTAqc

regeneratePdfbooleanOptional

Regenerate the invoice PDF immediately after the swap. Defaults to true.

Default: true

Response schema

1 status code documented

200Success

successbooleanRequired

fileobjectOptional

tokenstringRequired

filenamestringRequired

sizenumberRequired

downloadUrlstringRequired

Response example

application/json

{
  "success": false,
  "file": {
    "token": "example_token",
    "filename": "example_filename",
    "size": 0,
    "downloadUrl": "example_downloadUrl"
  }
}

Request example

POST /bff/document/change-customer

post

curl -X POST "https://api.bizkithub.com/bff/document/change-customer" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "id": "aB3xKm9pQ2wLn4Yz",
  "customerId": "aHRj9aHo9cXcTAqc",
  "regeneratePdf": true
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key