Create Override

Creates a new manual override.

post

Body

application/jsontext/jsonapplication/*+json

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

$metaall of | nullableOptional

Platform entity metadata.

namestringOptional

Represents the name associated with the entity.

Example: Sample Entity

iconstring | nullableOptional

Represents the icon linked to the entity, if applicable.

Example: icon.png

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

201

Created

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

post

HTTPcURLJavaScriptPython

POST /public/v1/billing/manual-overrides HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 2565

{
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "Sample Entity",
  "icon": "icon.png",
  "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",
        "audit": {
          "created": {
            "at": "2025-06-01T19:12:26.813Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text"
            }
          },
          "updated": {
            "at": "2025-06-01T19:12:26.813Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text"
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "icon": "text"
      }
    },
    "disabled": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2025-06-01T19:12:26.813Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text"
            }
          },
          "updated": {
            "at": "2025-06-01T19:12:26.813Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text"
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "icon": "text"
      }
    }
  },
  "id": "BOV-1234-1234",
  "client": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2025-06-01T19:12:26.813Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text"
        }
      },
      "updated": {
        "at": "2025-06-01T19:12:26.813Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text"
        }
      }
    },
    "$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": "[e-mail]",
    "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": {
        "at": "2025-06-01T19:12:26.813Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text"
        }
      },
      "updated": {
        "at": "2025-06-01T19:12:26.813Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text"
        }
      }
    },
    "$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": "[e-mail]",
    "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"
}

application/jsontext/jsonapplication/*+json

{
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "Sample Entity",
  "icon": "icon.png",
  "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",
        "audit": {
          "created": {
            "at": "2025-06-01T19:12:26.813Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text"
            }
          },
          "updated": {
            "at": "2025-06-01T19:12:26.813Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text"
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "icon": "text"
      }
    },
    "disabled": {
      "at": "2025-04-30T14:30:00.0000000+00:00",
      "by": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2025-06-01T19:12:26.813Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text"
            }
          },
          "updated": {
            "at": "2025-06-01T19:12:26.813Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text"
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "icon": "text"
      }
    }
  },
  "id": "BOV-1234-1234",
  "client": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2025-06-01T19:12:26.813Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text"
        }
      },
      "updated": {
        "at": "2025-06-01T19:12:26.813Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text"
        }
      }
    },
    "$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": "[e-mail]",
    "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": {
        "at": "2025-06-01T19:12:26.813Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text"
        }
      },
      "updated": {
        "at": "2025-06-01T19:12:26.813Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text"
        }
      }
    },
    "$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": "[e-mail]",
    "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"
}