Sign in
BillConfig

Update BillConfig

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

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

Changed in 1 of the 10 revisions of this API.71

  • ac93d1a9e6d971See the full diff
    • ●

      removed the optional property billLockDate from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property createdBy from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property dtCreated from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property dtLastModified from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property lastModifiedBy from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property version from the response with the 200 status

      response-optional-property-removed

    • ○

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

      response-body-all-of-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog