Decreases the company credit with an Update

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.

Path parameters

creditId integer Required

Body

value number Required
currency string Required
operationType integer Required
comment string

[optional]
options object

Credit balance data transfer object interface.
Hide options attributes Show options attributes object
- purchase_order string Required
  
  Purchase order number.
- custom_reference_number string
  
  Custom Reference number.
- order_increment string Required
  
  Order increment.
- currency_display string Required
  
  Currency display.
- currency_base string Required
  
  Currency base.

Body

value number Required
currency string Required
operationType integer Required
comment string

[optional]
options object

Credit balance data transfer object interface.
Hide options attributes Show options attributes object
- purchase_order string Required
  
  Purchase order number.
- custom_reference_number string
  
  Custom Reference number.
- order_increment string Required
  
  Order increment.
- currency_display string Required
  
  Currency display.
- currency_base string Required
  
  Currency base.

Responses

200

application/json

application/json application/xml

200 Success.

true on success

true on success
401

application/json

application/json application/xml

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
default

application/json

application/json application/xml

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

POST /V1/companyCredits/{creditId}/decreaseBalance

curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/companyCredits/{creditId}/decreaseBalance' \
 --header "Content-Type: application/json" \
 --data '{"value":42.0,"currency":"string","operationType":42,"comment":"string","options":{"purchase_order":"string","custom_reference_number":"string","order_increment":"string","currency_display":"string","currency_base":"string"}}'

curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/companyCredits/{creditId}/decreaseBalance' \
 --header "Content-Type: application/xml"

Request examples

{
  "value": 42.0,
  "currency": "string",
  "operationType": 42,
  "comment": "string",
  "options": {
    "purchase_order": "string",
    "custom_reference_number": "string",
    "order_increment": "string",
    "currency_display": "string",
    "currency_base": "string"
  }
}

Request examples

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <value type="float">42.0</value>
  <currency>string</currency>
  <operationType type="integer">42</operationType>
  <comment>string</comment>
  <options>
    <purchase-order>string</purchase-order>
    <custom-reference-number>string</custom-reference-number>
    <order-increment>string</order-increment>
    <currency-display>string</currency-display>
    <currency-base>string</currency-base>
  </options>
</root>

Response examples (200)

true

Response examples (200)

true

Response examples (401)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (401)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>

Response examples (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (default)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>