Update the following company credit attributes: credit currency

PUT /V1/companyCredits/{id}

Update the following company credit attributes: credit currency, credit limit and setting to exceed credit.

Path parameters

id string Required

Body

creditLimit object Required

Credit Limit data transfer object interface.
Hide creditLimit attributes Show creditLimit attributes object
- id integer
  
  ID.
- company_id integer
  
  Company id.
- credit_limit number
  
  Credit Limit.
- balance number
  
  Balance.
- currency_code string
  
  Currency Code.
- exceed_limit boolean Required
  
  Exceed Limit.
- available_limit number
  
  Available Limit.
- credit_comment string
  
  Credit comment for company credit history.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\CompanyCredit\Api\Data\CreditLimitInterface

Responses

200

200 Success.
Hide response attributes Show response attributes object
- id integer
  
  ID.
- company_id integer
  
  Company id.
- credit_limit number
  
  Credit Limit.
- balance number
  
  Balance.
- currency_code string
  
  Currency Code.
- exceed_limit boolean Required
  
  Exceed Limit.
- available_limit number
  
  Available Limit.
- credit_comment string
  
  Credit comment for company credit history.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\CompanyCredit\Api\Data\CreditLimitInterface
401

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  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 item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
500

Internal Server error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  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 item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
400

400 Bad Request
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  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 item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
default

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  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 item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

PUT /V1/companyCredits/{id}

curl \
 -X PUT https://magento2.winkelstraat.mac/rest/all/V1/companyCredits/{id} \
 -d '{"creditLimit":{"id":42,"company_id":42,"credit_limit":42.0,"balance":42.0,"currency_code":"string","exceed_limit":true,"available_limit":42.0,"credit_comment":"string","extension_attributes":{}}}'

Request examples

{
  "creditLimit": {
    "id": 42,
    "company_id": 42,
    "credit_limit": 42.0,
    "balance": 42.0,
    "currency_code": "string",
    "exceed_limit": true,
    "available_limit": 42.0,
    "credit_comment": "string",
    "extension_attributes": {}
  }
}

Response examples (200)

{
  "id": 42,
  "company_id": 42,
  "credit_limit": 42.0,
  "balance": 42.0,
  "currency_code": "string",
  "exceed_limit": true,
  "available_limit": 42.0,
  "credit_comment": "string",
  "extension_attributes": {}
}

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 (500)

{
  "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 (400)

{
  "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)

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