API
Get Vendor Credit History
GET
/v1/billing-service/vendors/{external-vendor-id}/credit-history
Endpoint to get the credit History for a vendor.
Authentication
Topsort’s APIs are authenticated via bearer tokens. Requests must include an authorization header containing your private API key.
Don't have an API key yet? Learn how to generate one.
Authorization
required
string
The header containing a private API key. Format this header as follows:
Authorization: Bearer <YOUR-API-KEY>
Path Parameters
object
external-vendor-id
required
The External ID of the Vendor to retrieve.
string
The External ID of the Vendor to retrieve.
Responses
Successful Response
This is the Response body for the Vendor Credit History fetch.
application/json
object
currencyCode
required
string
lines
required
Array<object>
This contains the details for the Credit History for a Vendor.
object
amount
required
number
createdAt
required
string format: date-time
description
required
string
totalAmount
required
number
Validation Error
application/json
object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string