Skip to main content

List Vendor Credit Reasons

GET 
/api/vendor-credits/credit-reasons

List the reasons a supplier issues a credit and the per-line cost behaviours they default to, with the plain-English explanation each option shows.

Required scope: accounting:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

reasons[] — value is what you send as credit_reason on a vendor credit; default_cost_impact is the behaviour product lines take when that reason is set (non-product lines are always financial_only). A reason is a default, never a lock — any line can still be set individually.

cost_impacts[] — the four cost_impact values a line can carry: return_goods (the goods go back to the supplier; stock drops when the return shipment is recorded), write_off_goods (the goods stay but cannot be sold; stock drops on authorize), reduce_cost (you keep the goods and the supplier charged too much; quantity is unchanged and the unit cost of the credited goods goes down — units still in stock get cheaper, units already sold get a cost-of-goods true-up), financial_only (only what you owe changes; stock quantity and cost are untouched).

Authentication: Requires Bearer token (PAT).

Request​

Responses​

OK

Response Headers
    Content-Type