companyCredits/history

GET

/V1/companyCredits/history

Returns the credit history for one or more companies.

请求示例

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'http:///V1/companyCredits/history'

响应示例

200 - 示例 1

{
    "items": [
        {
            "amount": 0,
            "available_limit": 0,
            "balance": 0,
            "comment": "string",
            "company_credit_id": 0,
            "credit_limit": 0,
            "currency_credit": "string",
            "currency_operation": "string",
            "datetime": "string",
            "id": 0,
            "purchase_order": "string",
            "rate": 0,
            "rate_credit": 0,
            "type": 0,
            "user_id": 0,
            "user_type": 0
        }
    ],
    "search_criteria": {
        "current_page": 0,
        "filter_groups": [
            {
                "filters": [
                    {
                        "condition_type": "string",
                        "field": "string",
                        "value": "string"
                    }
                ]
            }
        ],
        "page_size": 0,
        "sort_orders": [
            {
                "direction": "string",
                "field": "string"
            }
        ]
    },
    "total_count": 0
}

请求参数

Query 参数

searchCriteria[filterGroups][0][filters][0][field]

string

Field

可选

searchCriteria[filterGroups][0][filters][0][value]

string

Value

可选

searchCriteria[filterGroups][0][filters][0][conditionType]

string

可选

Condition type

searchCriteria[sortOrders][0][field]

string

可选

Sorting field.

searchCriteria[sortOrders][0][direction]

string

可选

Sorting direction.

searchCriteria[pageSize]

integer

可选

Page size.

searchCriteria[currentPage]

integer

可选

Current page.

返回响应

🟢200成功

application/json

200 Success.

Body

Interface for History search results.

items

array[object (company-credit-data-history-data-interface) {16}]

必需

History list.

amount

number

Amount.

必需

available_limit

number

可选

Available limit.

balance

number

必需

Outstanding balance.

comment

string

Comment.

可选

company_credit_id

integer

可选

Company credit id.

credit_limit

number

必需

Credit limit.

currency_credit

string

可选

Currency code of credit.

currency_operation

string

可选

Currency code of operation.

datetime

string

可选

Operation datetime.

integer

ID.

可选

purchase_order

string

可选

Purchase Order number.

rate

number

必需

Currency rate between credit and operation currencies.

rate_credit

number

可选

Rate between credit and base currencies.

type

integer

可选

Type of operation.

user_id

integer

User Id.

可选

user_type

integer

可选

User type: integration, admin, customer.

search_criteria

object (framework-search-criteria-interface)

必需

Search criteria interface.

current_page

integer

可选

Current page.

filter_groups

array[object (framework-search-filter-group) {1}]

必需

A list of filter groups.

page_size

integer

可选

Page size.

sort_orders

array[object (framework-sort-order) {2}]

可选

Sort order.

total_count

integer

必需

Total count.

🟠401没有权限

🔴500服务器错误

修改于 2024-11-22 03:29:06

companyCredits/company/{companyId}

companyCredits/history/{historyId}