M3m3ter-com
BillConfig

Update BillConfig

Changed on

Update the Organization-wide BillConfig.

You can use this endpoint to set a global lock date for all Bills - any Bill with a service period end date on or before the set date will be locked and cannot be updated or recalculated.

put/organizations/{orgId}/billconfig

Request

Path parameters

orgIdstring required

UUID of the organization. The Organization represents your company as a direct customer of the m3ter service.

Request body

versioninteger

The version number:

  • Default value when newly created is one.
  • On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response
billLockDatestring date

The global lock date when all Bills will be locked (in ISO 8601 format).

For example: "2024-03-01".

Response

Return the updated BillConfig

idstring required

The UUID of the entity.

versioninteger

The version number:

  • Create: On initial Create to insert a new entity, the version is set at 1 in the response.
  • Update: On successful Update, the version is incremented by 1 in the response.
billLockDatestring date

The global lock date (in ISO 8601 format) when all Bills will be locked.

For example: "2024-03-01".

dtCreatedstring date-time

The DateTime (in ISO-8601 format) when the bill config was first created.

dtLastModifiedstring date-time

The DateTime (in ISO-8601 format) when the bill config was last modified.

createdBystring

The id of the user who created this bill config.

lastModifiedBystring

The id of the user who last modified this bill config.

Changes

  • 85c514abc692Revision changes
    • breaking

      the response's property type changed from no type to object for status

  • ac93d1a9e6d9Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added subschema #2 to the response body allOf list for the response status