ReDoc documentation

companyCredits/{creditId}/decreaseBalance

companyCredits/{creditId}/decreaseBalance

post/V1/companyCredits/{creditId}/decreaseBalance

Decreases the company credit with an Update, Reimburse, or Purchase transaction. This transaction increases company's outstanding balance and decreases company's available credit.

Request
path Parameters
creditId
required
integer
Request Body schema:
comment
string

[optional]

currency
required
string
operationType
required
integer
object (company-credit-data-credit-balance-options-interface)

Credit balance data transfer object interface.

value
required
number
Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

Request samples
{
  • "value": 0,
  • "currency": "string",
  • "operationType": 0,
  • "comment": "string",
  • "options": {
    }
}
Response samples
true