Update Override
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.
idstringOptionalExample:
The unique identifier of the manual override.
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 ofOptionalExample:
Indicates the current status of the manual override.
Active
string · enumOptionalPossible values:
Represents the status of a manual override in the billing system.
externalIdstring | nullableOptionalExample:
Represents an external identifier for the manual override, if applicable.
EXT-12345
notesstring | nullableOptionalExample:
Contains additional notes or comments related to the manual override.
Adjustment for Q1 billing
Responses
200
OK
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:
Content-Type: application/json
Accept: */*
Content-Length: 2446
{
"$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": "text",
"status": "text",
"serviceLevel": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "[email protected]",
"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": "text",
"status": "text",
"serviceLevel": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "[email protected]",
"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": "text",
"status": "text",
"serviceLevel": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "[email protected]",
"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": "text",
"status": "text",
"serviceLevel": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"technicalSupportEmail": "[email protected]",
"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"
}
Last updated
Was this helpful?