Returns data on the credit limit for a specified company

GET /V1/companyCredits/company/{companyId}

Returns data on the credit limit for a specified company.

Path parameters

companyId integer Required

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
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

GET /V1/companyCredits/company/{companyId}

curl \
 -X GET https://magento2.winkelstraat.mac/rest/all/V1/companyCredits/company/{companyId}

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

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