v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
Credits

Create credit

Create a new credit.

post/v1/Credits

Request body

credit_memo_idinteger

Primary identifier for this credit.

descriptionstring required

Memo for credit.

product_type_idinteger

ID of the product type on this credit.

product_idinteger

ID of the product on this credit.

service_product_idinteger

ID of the service product on this credit.

balancenumber double

Customer balance at the time the credit was applied.

closed_datestring date-time
buy_ratenumber double
atypestring

Type of credit. (FCC, MRC, NRC, OCC, ADJ)

created_datestring date-time

Date the credit was created.

created_byinteger

ID of user that created the credit.

tax_class_idinteger

ID of tax class on the credit.

customer_idinteger required

ID of customer on the credit.

bill_idinteger

ID of bill the credit is applied to.

service_idinteger

ID of service on a customer account.

amountnumber double

Total dollar amount including taxes and product amounts on credit.

product_amountnumber double

Dollar amount of product on this credit.

tax_amountnumber double

Tax amount on this credit.

geocodestring

Location of the credit.

prorationnumber double

Dollar amount prorated over the credit's start and end dates.

is_tax_includedboolean required

Tax amounts are included in the credit amount field.

costnumber double

Cost of the credit.

is_bad_debtboolean

Identifies a credit as bad debt.

quantitynumber double required

Units of product or product type on the transaction.

ratenumber double required

Rate of product associated to this transaction

is_proratedboolean required

Is proration of transaction required

start_datestring date-time required

Billing start date of product or product type associated to this transaction

end_datestring date-time required

Billing end date of product or product type associated to this transaction

Response

Created

okboolean
idinteger