Update Override

Updates an existing manual override.

put

Path parameters

idstringRequired

The ID of the manual override to update.

Body

Represents a manual override in the billing system, allowing specific adjustments to billing processing.

$metaall of | nullableOptional

Platform entity metadata.

auditall ofOptional

Contains audit-related details for the entity.

idstringOptional

The unique identifier of the manual override.

Example: BOV-1234-1234

clientall ofOptional

Specifies the client account associated with the manual override.

vendorall ofOptional

Specifies the vendor account associated with the manual override.

statusall ofOptional

Indicates the current status of the manual override.

Example: Active

string · enumOptional

Represents the status of a manual override in the billing system.

Possible values:

externalIdstring | nullableOptional

Represents an external identifier for the manual override, if applicable.

Example: EXT-12345

notesstring | nullableOptional

Contains additional notes or comments related to the manual override.

Example: Adjustment for Q1 billing

Responses

200

application/json

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

put

PUT /public/v1/billing/manual-overrides/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 2440

{
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "audit": {
    "created": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updated": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "active": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "disabled": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    }
  },
  "id": "BOV-1234-1234",
  "client": {
    "id": "text",
    "audit": {
      "created": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      },
      "updated": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "icon": "text",
    "externalIds": {
      "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "externalId": "text",
    "externalName": "text",
    "type": "Client",
    "status": "Active",
    "serviceLevel": "Express",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "technicalSupportEmail": "text",
    "website": "text",
    "description": "text",
    "name": "text",
    "groups": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "logo": "text",
        "isDefault": true
      }
    ],
    "eligibility": {
      "client": true,
      "partner": true
    }
  },
  "vendor": {
    "id": "text",
    "audit": {
      "created": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      },
      "updated": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "icon": "text",
    "externalIds": {
      "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "externalId": "text",
    "externalName": "text",
    "type": "Client",
    "status": "Active",
    "serviceLevel": "Express",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "technicalSupportEmail": "text",
    "website": "text",
    "description": "text",
    "name": "text",
    "groups": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "logo": "text",
        "isDefault": true
      }
    ],
    "eligibility": {
      "client": true,
      "partner": true
    }
  },
  "status": "Active",
  "externalId": "EXT-12345",
  "notes": "Adjustment for Q1 billing"
}

{
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "audit": {
    "created": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updated": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "active": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "disabled": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text"
      }
    }
  },
  "id": "BOV-1234-1234",
  "client": {
    "id": "text",
    "audit": {
      "created": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      },
      "updated": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "icon": "text",
    "externalIds": {
      "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "externalId": "text",
    "externalName": "text",
    "type": "Client",
    "status": "Active",
    "serviceLevel": "Express",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "technicalSupportEmail": "text",
    "website": "text",
    "description": "text",
    "name": "text",
    "groups": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "logo": "text",
        "isDefault": true
      }
    ],
    "eligibility": {
      "client": true,
      "partner": true
    }
  },
  "vendor": {
    "id": "text",
    "audit": {
      "created": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      },
      "updated": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "icon": "text",
    "externalIds": {
      "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "externalId": "text",
    "externalName": "text",
    "type": "Client",
    "status": "Active",
    "serviceLevel": "Express",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "technicalSupportEmail": "text",
    "website": "text",
    "description": "text",
    "name": "text",
    "groups": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "logo": "text",
        "isDefault": true
      }
    ],
    "eligibility": {
      "client": true,
      "partner": true
    }
  },
  "status": "Active",
  "externalId": "EXT-12345",
  "notes": "Adjustment for Q1 billing"
}

PreviousCreate Override NextCustom Ledger

Last updated 2 months ago

Was this helpful?