Skip to main content
PUT
/
api
/
billing
/
invoices
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
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

Id
integer
required
The Id of the Invoice record to update.
BusinessId
integer
required
Business Id.
BillToName
string
required
Name of the person or organisation being billed, captured at invoice time.
BillToAddress
string
required
Billing street address, captured at invoice time.
BillToCity
string
required
Billing city, captured at invoice time.
BillToPostCode
string
required
Billing postal/ZIP code, captured at invoice time.
BillToCountryId
integer
required
Bill To Country Id.

Optional Fields

BillToTaxIDNumber
string
Tax identification number (VAT/GST/EIN) of the billed party, captured at invoice time.
BillToPhone
string
Billing phone number, captured at invoice time.
BillToFax
string
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

Status
integer
HTTP status code. 200 on success.
Message
string
A human-readable message confirming the update.
Value
object
Contains the Id of the updated record.
WasSuccessful
boolean
true if the invoice was updated successfully.
Errors
array
null on success.
Example Response
{
  "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

Message
string
A summary of the validation error(s), in the format PropertyName: error message.
Value
any
null on validation failure.
Errors
object[]
Array of validation errors.
WasSuccessful
boolean
false when the request fails validation.
Example Response
{
  "Message": "InvoiceNumber: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "InvoiceNumber"
    }
  ],
  "WasSuccessful": false
}