Skip to main content
POST
Un-apply one application of a vendor credit

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Headers

Idempotency-Key
string

A key that already un-applied this credit answers that result again and writes nothing.

Path Parameters

id
string<uuid>
required

Vendor credit UUID.

Body

application/json
application_id
string<uuid>
required

The application to take back (the credit's applications[].id).

reason
string
required

Why; kept on the credit and the bill.

Maximum string length: 500
bill_id
string<uuid>

An application inside a payment: the bill whose share the credit paid.

effective_date
string<date>

The day of the reversal entry (an application with its own entry); defaults to today.

Response

The application was taken back, or already was under this Idempotency-Key (idempotent_replay).

data
object
idempotent_replay
boolean