M3m3ter-com
Credits

Create Credit Line Item

Changed on

Create a new Credit line item for the given Bill.

When creating Credit line items for Bills, use the Credit Reasons created for your Organization. See CreditReason.

post/organizations/{orgId}/bills/{billId}/creditlineitems

Request

Path parameters

orgIdstring required

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

billIdstring required

UUID of the bill.

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.
reasonIdstring

The UUID of the line item reason.

lineItemType'STANDING_CHARGE' | 'USAGE' | 'COUNTER_RUNNING_TOTAL_CHARGE' | 'COUNTER_ADJUSTMENT_DEBIT' | 'COUNTER_ADJUSTMENT_CREDIT' | 'USAGE_CREDIT' | 'MINIMUM_SPEND' | 'MINIMUM_SPEND_REFUND' | 'CREDIT_DEDUCTION' | 'MANUAL_ADJUSTMENT' | 'CREDIT_MEMO' | 'DEBIT_MEMO' | 'COMMITMENT_CONSUMED' | 'COMMITMENT_FEE' | 'OVERAGE_SURCHARGE' | 'OVERAGE_USAGE' | 'BALANCE_CONSUMED' | 'BALANCE_FEE' | 'AD_HOC'

See Bill Line Item Types for more information.

amountToApplyOnBillnumber
productIdstring required

The UUID of the Product.

accountingProductIdstring required
descriptionstring required

The description for the line item.

amountnumber required

The amount for the line item.

referencedBillIdstring required

The UUID of the bill for the line item.

referencedLineItemIdstring required

The UUID of the line item.

servicePeriodStartDatestring date-time required

The service period start date in ISO-8601 format. (inclusive of the starting date).

servicePeriodEndDatestring date-time required

The service period end date in ISO-8601 format.(exclusive of the ending date).

creditReasonIdstring

The UUID of the credit reason.

Response

Returns the new credit line item

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.
lineItemType'STANDING_CHARGE' | 'USAGE' | 'COUNTER_RUNNING_TOTAL_CHARGE' | 'COUNTER_ADJUSTMENT_DEBIT' | 'COUNTER_ADJUSTMENT_CREDIT' | 'USAGE_CREDIT' | 'MINIMUM_SPEND' | 'MINIMUM_SPEND_REFUND' | 'CREDIT_DEDUCTION' | 'MANUAL_ADJUSTMENT' | 'CREDIT_MEMO' | 'DEBIT_MEMO' | 'COMMITMENT_CONSUMED' | 'COMMITMENT_FEE' | 'OVERAGE_SURCHARGE' | 'OVERAGE_USAGE' | 'BALANCE_CONSUMED' | 'BALANCE_FEE' | 'AD_HOC'

See Bill Line Item Types for more information.

productIdstring
descriptionstring
servicePeriodStartDatestring date-time
servicePeriodEndDatestring date-time
referencedBillIdstring
referencedLineItemIdstring
dtCreatedstring date-time

The DateTime when the line item was created.

dtLastModifiedstring date-time

The DateTime when the line item was last modified.

createdBystring

The ID of the user who created this line item.

lastModifiedBystring

The ID of the user who last modified this line item.

amountnumber

The credit amount.

creditReasonIdstring

The UUID of the credit reason for this credit line item.

Changes

  • 85c514abc692Revision changes
    • breaking

      the //// request property type changed from no type to object

    • 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

  • 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

    • info

      added the new optional request property /////

    • info

      added the new optional request property /

    • info

      added the new AD_HOC enum value to the request property /////

    • info

      added to the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status

    • info

      added the optional property / to the response with the status