URL Expired

The URL for this request expired after 30 days.

account_id

string

required

ID of the Account

Body of request to create credit offset.

line_item_id

string

^(?!can_).*$

The ID associated to be with the line item for future requests. If not provided on line item creation, Canopy will generate this field.

original_amount_cents

integer

required

Defaults to 0

The payment amount in cents.

effective_at

date-time

The Date-Time that the credit offset is applicable to the account. Although the credit offset is created in Canopy today, it can actually be effective as of a date in the past. This should only be used for data migrations.

allocation

string

enum

Optional designation for which balance bucket the credit offset should be allocated to.

INTERESTINTERESTDEFERRED_INTERESTPRINCIPALFEEAM_INTEREST

Allowed:

INTEREST``DEFERRED_INTEREST``PRINCIPAL``FEE``AM_INTEREST

external_fields

array,null | object,null

external_fieldsarray,null | object,null

root_id

string

The ID of the Loan Line Item this credit offset will be created under.

Add Field

``200 Credit offset created

``401

Unauthorized.

``403

Forbidden.

``422

Invalid input

``429

Too many requests.

``default

Unexpected Error.

Updated about 1 year ago

ShellNodeRubyPHPPython

Bearer

Base URL

https://Contact sales to enable your sandbox/accounts/{account_id}/line_items/credit_offsets

xxxxxxxxxx

curl --request POST \

--url https://contact/%20sales%20to%20enable%20your%20sandbox/accounts//line_items/credit_offsets \

--header 'accept: application/json' \

--header 'content-type: application/json' \

--data '

{

"original_amount_cents": 0

}

'

application/json

``200

Updatedabout 1 year ago