---
updatedAt: 2026-04-23T04:17:15.000Z
agentTools:
  projectIndex: https://docs.vopay.com/llms.txt
---

# journal-entry/add

This endpoint allows you to add journal entry into the VoPay platform. Journals do not represent real funds. They are considered offbook funds, and are designed to represent transactions that have occured outside the VoPay platform.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "2.0",
    "title": "Payment Rails",
    "description": "The Payment Rails API allows you to manage transactions in your account. You can cancel transactions, refund transactions, and confirm flagged transactions.",
    "contact": {
      "name": "API Support",
      "email": "help@vopay.com"
    }
  },
  "paths": {
    "/journal-entry/add": {
      "post": {
        "description": "This endpoint allows you to add journal entry into the VoPay platform. Journals do not represent real funds. They are considered offbook funds, and are designed to represent transactions that have occured outside the VoPay platform.",
        "summary": "journal-entry/add",
        "tags": [
          "Journal Entry Endpoints"
        ],
        "operationId": "JournalEntryAddPost",
        "deprecated": false,
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "AccountID": {
                    "description": "Your account ID",
                    "type": "string"
                  },
                  "Key": {
                    "description": "API key for the account",
                    "type": "string"
                  },
                  "Signature": {
                    "description": "Hashed signature for the request",
                    "type": "string"
                  },
                  "Currency": {
                    "description": "3 character currency code for the currency to mark the currency that was used for the journal entry.",
                    "type": "string"
                  },
                  "CreditAmount": {
                    "description": "The credit amount for the journal entry. Either one of CreditAmount or DebitAmount must be provided.",
                    "type": "string"
                  },
                  "DebitAmount": {
                    "description": "The debit amount for the journal entry. Either one of CreditAmount or DebitAmount must be provided.",
                    "type": "string"
                  },
                  "TransactionDate": {
                    "description": "The transaction date for the journal entry. Must be specified in YYYY-MM-DD format.",
                    "type": "string",
                    "format": "date"
                  },
                  "FullName": {
                    "description": "Full name of the indivdual or business for whom the journal entry is being created.",
                    "type": "string"
                  },
                  "Status": {
                    "description": "The transaction status for the journal entry.",
                    "type": "string"
                  },
                  "Notes": {
                    "description": "An optional note to associate with the journal entry.",
                    "type": "string"
                  },
                  "ClientReferenceNumber": {
                    "description": "An optional reference number to associate with the journal entry.",
                    "type": "string"
                  },
                  "ClientAccountID": {
                    "description": "The Client Account ID that the journal entry belong to.",
                    "type": "string",
                    "format": "int32"
                  }
                },
                "required": [
                  "AccountID",
                  "Key",
                  "Signature",
                  "Currency",
                  "CreditAmount",
                  "DebitAmount",
                  "TransactionDate",
                  "FullName",
                  "Status"
                ]
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "Success": {
                      "type": "boolean",
                      "description": "True if the request was successful, false if it failed",
                      "example": true
                    },
                    "ErrorMessage": {
                      "type": "string",
                      "description": "Contains a description of the error if the request failed",
                      "example": ""
                    },
                    "JournalEntryID": {
                      "type": "integer",
                      "description": "The unique ID of the journal entry that was just created. This ID should be saved as it is required in order to look up or edit the journal entry.",
                      "example": "1122"
                    }
                  },
                  "required": [
                    "Success",
                    "ErrorMessage",
                    "JournalEntryID"
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://earthnode-dev.vopay.com/api/v2"
    }
  ]
}
```