Journal Entry Endpoints

journal-entry/edit

This endpoint allows you to edit journal entry that was previously saved the VoPay platform.

post/journal-entry/edit

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/journal-entry/edit
  • Auth
    none declared

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

JournalEntryIDinteger required

Searches for a journal entry transaction with the specified journal entry ID. If the journal entry ID is not found in our system, an error will be thrown.

Currencystring

3 character currency code for the currency to mark the currency that was used for the journal entry. If specified, the specified journal entry will be updated with the new value.

CreditAmountstring

The credit amount for the journal entry. Only one of the CreditAmount or DebitAmount can be non-zero.

DebitAmountstring

The debit amount for the journal entry. Only one of the CreditAmount or DebitAmount can be non-zero.

TransactionDatestring date

The transaction date for the journal entry. Should be specified in YYYY-MM-DD format. If specified, the specified journal entry will be updated with the new value.

FullNamestring

Full name of the indivdual or business for whom the journal entry is being created. If specified, the specified journal entry will be updated with the new value.

Statusstring

The transaction status for the journal entry. If specified, the specified journal entry will be updated with the new value.

Notesstring

An optional note to associate with the journal entry transaction. If specified, the specified journal entry will be updated with the new value.

ClientReferenceNumberstring

An optional reference number to associate with the journal entry transaction. If specified, the specified journal entry will be updated with the new value.

ClientAccountIDstring int32

The Client Account ID that the journal entry belongs to. If specified, the specified journal entry will be updated with the new value.

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

JournalEntryIDinteger required

The unique ID of the journal entry that was edited.

Example response

{
  "Success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.