M3m3ter-com
CounterAdjustments

Create CounterAdjustment

Changed on

Create a new CounterAdjustment for an Account using a Counter.

Notes:

  • Use the new absolute value for the Counter for the selected date - if it was 15 and has increased to 20, enter 20; if it was 15 and has decreased to 10, enter 10. Do not enter the plus or minus value relative to the previous Counter value on the Account.
  • CounterAdjustments on Accounts are supported down to a specific day of granularity - you cannot create more than one CounterAdjustment for any given day using the same Counter and you'll receive an error if you try to do this.
post/organizations/{orgId}/counteradjustments

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 of the entity:

  • Create entity: Not valid for initial insertion of new entity - do not use for Create. On initial Create, version is set at 1 and listed in the response.
  • Update Entity: 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.
counterIdstring required

The ID of the Counter used for the CounterAdjustment on the Account.

accountIdstring required

The Account ID the CounterAdjustment is created for.

datestring required

The date the CounterAdjustment is created for the Account (in ISO-8601 date format).

Note: CounterAdjustments on Accounts are supported down to a specific day of granularity - you cannot create more than one CounterAdjustment for any given day using the same Counter and you'll receive an error if you try to do this.

valueinteger required

Integer Value of the Counter used for the CounterAdjustment.

Note: Use the new absolute value for the Counter for the selected date - if it was 15 and has increased to 20, enter 20; if it was 15 and has decreased to 10, enter 10. Do not enter the plus or minus value relative to the previous Counter value on the Account.

purchaseOrderNumberstring

Purchase Order Number for the Counter Adjustment. (Optional)

Example request

{
  "date": "2022-01-04"
}

Response

Returns the created CounterAdjustment

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.
dtCreatedstring date-time

The DateTime when this item was created (in ISO-8601 format).

dtLastModifiedstring date-time

The DateTime when this item was last modified (in ISO-8601 format).

createdBystring

The ID of the user who created this item.

lastModifiedBystring

The ID of the user who last modified this item.

counterIdstring

The ID of the Counter that was used to make the CounterAdjustment on the Account.

accountIdstring

The Account ID the CounterAdjustment was created for.

datestring date

The date the CounterAdjustment was created for the Account (in ISO-8601 date format).

valueinteger

Integer Value of the Counter that was used to make the CounterAdjustment.

purchaseOrderNumberstring

Purchase Order Number for the Counter Adjustment. (Optional)

Changes

  • 85c514abc692Revision changes
    • breaking

      the request property type changed from no type to object

    • breaking

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

    • breaking

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

  • 9f9e5f3dbde7Revision changes
    • breaking

      the response property //////// became optional for the status

    • breaking

      the response property //// became optional for the status