Updates an existing Invoice record. You must include the Id of the record to update along with all required fields.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header.
The authenticated user must be a full unrestricted administrator or have the Invoice-Edit role.
Request Body
Required Fields
The Id of the Invoice record to update.
Name of the person or organisation being billed, captured at invoice time.
Billing street address, captured at invoice time.
Billing city, captured at invoice time.
Billing postal/ZIP code, captured at invoice time.
Optional Fields
Tax identification number (VAT/GST/EIN) of the billed party, captured at invoice time.
Billing phone number, captured at invoice time.
Billing fax number, captured at invoice time.
Code Examples
curl -X PUT \
"https://spaces.nexudus.com/api/billing/invoices" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"BusinessId": 0,
"BillToName": "",
"BillToAddress": "",
"BillToCity": "",
"BillToPostCode": "",
"BillToCountryId": 0,
"Id": 87654321
}'
Response
200
HTTP status code. 200 on success.
A human-readable message confirming the update.
Contains the Id of the updated record.
true if the invoice was updated successfully.
{
"Status" : 200 ,
"Message" : "Invoice was successfully updated." ,
"Value" : {
"Id" : 87654321
},
"OpenInDialog" : false ,
"OpenInWindow" : false ,
"RedirectURL" : null ,
"JavaScript" : null ,
"UpdatedOn" : "2025-01-15T10:30:00Z" ,
"UpdatedBy" : "admin@example.com" ,
"Errors" : null ,
"WasSuccessful" : true
}
400
A summary of the validation error(s), in the format PropertyName: error message.
null on validation failure.
Array of validation errors. The value that was submitted for the field, or null if missing.
The validation error message.
The name of the property that failed validation.
false when the request fails validation.
{
"Message" : "InvoiceNumber: is a required field" ,
"Value" : null ,
"Errors" : [
{
"AttemptedValue" : null ,
"Message" : "is a required field" ,
"PropertyName" : "InvoiceNumber"
}
],
"WasSuccessful" : false
}