POST v1/journal-entries

Creates new or updates existing Journal Entry. This API performs full update for an existing journal entry so ensure that all parameters and IDs are correctly supplied when using this api for update.

Request Information

URI Parameters

None.

Body Parameters

Use JournalEntryID=0 to create new Journal Entry. If JournalEntryID is a non-zero positive value, this will attempt an update on existing journal entry which matches the supplied id.

JournalEntry
NameDescriptionTypeAdditional information
Id

Unique Journal Entry id. Set to 0 for new Journal Entry - auto generated by the system.

integer

Required

Range: inclusive between 0 and 2147483647

TxnNumber

JournalEntry Number - auto generated if blank. Set AllowDuplicateTxnNumber to true to bypass duplicate check.

string

None.

AllowDuplicateTxnNumber

Set to true if you want to skip duplicate check for TxnNumber

boolean

None.

TxnDate

Date the JournalEntry is entered.

date

Required

Memo

Journal Entry Memo

string

None.

Status

Read-Only - The Status of the Journal Entry. Status codes are Active (145) or Voided(146).

IdNamePair

None.

GLCategory

GLCategory associated with the Journal Entry - required if Category Tracking is turned on

IdNamePair

None.

LineItems

Collection of this Journal Entry's Line Items

Collection of JournalEntryLineItem

None.

Request Formats

application/json, text/json

Sample:
{
  "id": 1,
  "txnNumber": "sample string 2",
  "allowDuplicateTxnNumber": true,
  "txnDate": "2022-07-01T15:22:17.4277247-04:00",
  "memo": "sample string 5",
  "status": {
    "id": 1,
    "name": "sample string 2"
  },
  "glCategory": {
    "id": 1,
    "name": "sample string 2"
  },
  "lineItems": [
    {
      "id": 1,
      "glAccount": {
        "id": 1,
        "name": "sample string 2"
      },
      "memo": "sample string 2",
      "glCategory": {
        "id": 1,
        "name": "sample string 2"
      },
      "debit": 3.0,
      "credit": 4.0,
      "customerVendor": {
        "id": 1,
        "name": "sample string 2"
      }
    },
    {
      "id": 1,
      "glAccount": {
        "id": 1,
        "name": "sample string 2"
      },
      "memo": "sample string 2",
      "glCategory": {
        "id": 1,
        "name": "sample string 2"
      },
      "debit": 3.0,
      "credit": 4.0,
      "customerVendor": {
        "id": 1,
        "name": "sample string 2"
      }
    }
  ]
}

application/xml, text/xml

Sample:
<JournalEntry xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models.Accounting">
  <AllowDuplicateTxnNumber>true</AllowDuplicateTxnNumber>
  <GLCategory xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </GLCategory>
  <Id>1</Id>
  <LineItems>
    <JournalEntryLineItem>
      <Credit>4</Credit>
      <CustomerVendor xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </CustomerVendor>
      <Debit>3</Debit>
      <GLAccount xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </GLAccount>
      <GLCategory xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </GLCategory>
      <Id>1</Id>
      <Memo>sample string 2</Memo>
    </JournalEntryLineItem>
    <JournalEntryLineItem>
      <Credit>4</Credit>
      <CustomerVendor xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </CustomerVendor>
      <Debit>3</Debit>
      <GLAccount xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </GLAccount>
      <GLCategory xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </GLCategory>
      <Id>1</Id>
      <Memo>sample string 2</Memo>
    </JournalEntryLineItem>
  </LineItems>
  <Memo>sample string 5</Memo>
  <Status xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </Status>
  <TxnDate>2022-07-01T15:22:17.4277247-04:00</TxnDate>
  <TxnNumber>sample string 2</TxnNumber>
</JournalEntry>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.