Skip to content

Get manual ledger entry by ID

GET
/api/administration/ledger/manual-entries/{entryId}
curl --request GET \
--url https://api.wink.travel/api/administration/ledger/manual-entries/ \
--header 'Wink-Version: 2.0'

Returns a specific ledger entry by its document ID.

entryId
required
string
""

Ledger entry document ID

Wink-Version
string
default: 2.0.0
Allowed values: 2.0

OK

Media type application/json

Ledger keeps track of all incoming and outgoing funds for a certain account.

object
id

Document UUID

string
""
createdDate

Datetime this record was first created

string format: date-time
""
lastUpdate

Datetime this record was last updated

string format: date-time
""
version

Version property that shows how many times this document has been persisted. Document will not persist if the version property is less than current version property in the system. Result in an optimistic locking exception.

integer format: int64
""
accountIdentifier
required

The ID of the account to be credited / debited

string
"" >= 1 characters
accountName
required

The display name of the account to be credited / debited

string
"" >= 1 characters
description
required

A short description of the line item

string
"" >= 1 characters
referenceIdentifier
required

The source of this ledger entry. E.g. Booking contract identifier. Also related to fundsType.

string
"" >= 1 characters
referenceType
required

What the referenceIdentifier above relates to

string
""
Allowed values: BOOKING_CONTRACT DEPOSIT WITHDRAWAL TRANSFER
fundsType
required

Type of funds.

string
""
Allowed values: COMMISSION AFFILIATE_AGENCY_FEE SUPPLIER_AGENCY_FEE TRANSACTION_FEE FX_FEE PLATFORM_FEE SALE TRIP_PAY STRIPE_REFUND_FEE
type
required

Whether the entry is CREDIT or DEBIT

string
""
Allowed values: CREDIT DEBIT
accountType
required

The account type

string
""
Allowed values: ASSETS LIABILITIES EQUITY INCOME EXPENSES
accountUsageType
required

The account usage type

string
""
Allowed values: CASH RECEIVABLE PAYABLE INVENTORY CAPITAL
entry
required

Note: A debit should be a negative amount

object
amount
required
number
currency
required
string
>= 1 characters
metadata

Any relevant metadata that needs to go with the entry

object
key
additional properties
Example
null

Bad Request

object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com",
"properties": {
"additionalProperty": "example"
}
}

Unauthorized

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

Forbidden

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

Internal Server Error

object
Example generated
{}