GET
View a debt adjustment
Company space For: Buyer, Accountant · Permission: purchases.retrieve Part of Pay suppliers and adjust debt.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

purchase
string
required

Identifier of the purchase (27-character KSUID).

debt_adjustment
string
required

Identifier of the debt adjustment, which must belong to the purchase in the path (27-character KSUID string).

Query Parameters

response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, purchase_id, vendor_id, amount, reason, adjusted_at, created_by_user_id, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: purchase, purchase.items, purchase.debtAdjustments, purchase.returns, purchase.pickups, purchase.deliveries, purchase.vendor.

Response

200 - application/json

Resource.

id

Identifier of the debt adjustment (27-character KSUID string).

purchase_id

Identifier of the purchase whose debt was reduced.

vendor_id

Identifier of the supplier of the purchase, copied from it when the adjustment was created.

amount
number

Amount by which the debt was reduced in major units (the minor-unit amount divided by 10 to the power currency_exponent).

reason

Reason given for the reduction, for example a negotiated discount.

adjusted_at

Date and time the adjustment was recorded (ISO 8601). Set by the server.

created_by_user_id

Identifier of the member who recorded the adjustment; null when no signed-in member was known.

purchase
object

The adjusted purchase. Present only when requested with include=purchase.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).