Skip to main content

Update Invoice

PUT/rest/invoices/:invoice_number

Updates an existing invoice. Both PUT and PATCH are supported.

Request​

invoice_numberStringrequired
Append invoice number to /rest/invoices/#invoice_number
invoiceObjectrequired
Hash containing complete invoice information to update.
Example Request
PUT /rest/invoices/fhd-12102020
Authorization: Basic <base64(api_key:api_password)>
Content-Type: application/json
{
"invoice": {
  "debt_claim_number": "INV-2024-001",
  "first_name": "Peter",
  "last_name": "Struwwel",
  "amount": 10.55
}
}

Response​

invoiceObject
Hash containing complete invoice information. See Get Invoice for the full field list.
messageString
Success or error message from the API
errorString
Error details (null on success)
paylinkString
Direct payment link for the customer
qrcodeString
Base64-encoded QR code image for the payment. Suggested size 250PX with PNG format.
Example Response
{
"invoice": {
  "status": "pending",
  "created_at": "2024-08-14T07:50:20.123Z",
  "updated_at": "2024-08-14T07:50:20.123Z",
  "debt_claim_number": "INV-2024-001",
  "print_date": "2024-08-14",
  "first_name": "Peter",
  "last_name": "Struwwel",
  "address": "Teststr 5",
  "address2": "12B",
  "postal_code": "10178",
  "city": "Berlin",
  "country": "Germany",
  "email": "dev@betterpayment.de",
  "amount": 10.55,
  "amount_cents": 1055,
  "currency": "EUR",
  "description": "Payment for drinks",
  "customer_id": "123456",
  "state": "BE",
  "phone": "+4917143214321",
  "redirect_after_payments": false,
  "success_url": "https://example.com/success",
  "error_url": "https://example.com/error",
  "tax_id": "123456789",
  "expires_in": 24,
  "expires_in_unit": "hours",
  "expired": false,
  "uuid": "f34b3b2f-2680-4d62-a0c9-ce2e50ddbb8a",
  "channel_id": 123,
  "import_id": 456,
  "locale": "de",
  "effective_locale": "de",
  "send_initial_email": true,
  "initial_email_type": "initial",
  "effective_initial_email_type": "initial",
  "last_email": {
    "email_type": "reminder",
    "status": "sent",
    "sent_at": "2026-05-20T14:30:00Z",
    "recipient_email": "dev@betterpayment.de",
    "locale": "de"
  }
},
"message": "Invoice has been successfully created.",
"error": null,
"paylink": "http://yourchannel.jetztzahlen.de/pay/f34b3b2f-2680-4d62-a0c9-ce2e50ddbb8a",
"qrcode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
}
Last updated on