Re-tag a loan's counterparty type

PATCH/api/v1/loans/{instrument_id}/counterparty

Re-tag the counterparty classification of a loan.

Request Body:

counterparty_type: One of customer, vendor, shareholder, employee, affiliate, other.

Drives subledger grouping and shareholder-loan reporting.

Operation ID: update_loan_counterparty_api_v1_loans__instrument_id__counterparty_patch·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

instrument_idstringrequired

Request body

Schema: LoanCounterpartyUpdateRequest

counterparty_typeLoanCounterpartyTypeEnumrequiredLoanCounterpartyTypeEnum

Responses

200Successful Response

Schema: SuccessEnvelope_LoanCounterpartyUpdateResponse_

successboolean
messagestring
codestring
dataLoanCounterpartyUpdateResponse

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

PATCH/api/v1/loans/{instrument_id}/counterparty

bash

curl -X PATCH 'https://api.ondayzero.com/api/v1/loans/{instrument_id}/counterparty' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "counterparty_type": "string"
}'