GET
/
public
/
v1
/
billing-service
/
vendors
/
{external-vendor-id}
/
credit-history
Get Vendor Credit History
curl --request GET \
  --url https://api.topsort.com/public/v1/billing-service/vendors/{external-vendor-id}/credit-history \
  --header 'Authorization: Bearer <token>'
{
  "currencyCode": "<string>",
  "lines": [
    {
      "amount": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "description": "<string>"
    }
  ],
  "totalAmount": 123
}

Authorizations

Authorization
string
header
required

A valid API key generated in Topsort's UI.

Path Parameters

external-vendor-id
string
required

The External ID of the Vendor to retrieve.

Minimum length: 1

Response

Successful Response

Response body for the Vendor Credit History fetch.

currencyCode
string
required
lines
VendorCreditHistoryLine · object[]
required
totalAmount
number
required