POST api/Journal

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
id	integer	None.
accountingId	string	String length: inclusive between 0 and 20
journal	string	Required String length: inclusive between 0 and 20
documentNumber	string	String length: inclusive between 0 and 256
postingDate	date	Required
operationDate	date	Required
issueDate	date	Required
categoryDescription	string	String length: inclusive between 0 and 50
voucherType	string	String length: inclusive between 0 and 256
businessTransactionAmount	decimal number	None.
elements	Collection of JournalItem	Required
companyData	CompanyData	None.

Request Formats

application/json, text/json

Sample:

{
  "id": 1,
  "accountingId": "sample string 2",
  "journal": "sample string 3",
  "documentNumber": "sample string 4",
  "postingDate": "2025-11-08T13:42:51.8713726+01:00",
  "operationDate": "2025-11-08T13:42:51.8713726+01:00",
  "issueDate": "2025-11-08T13:42:51.8713726+01:00",
  "categoryDescription": "sample string 8",
  "voucherType": "sample string 9",
  "businessTransactionAmount": 10.0,
  "elements": [
    {
      "id": 1,
      "customerCode": "sample string 2",
      "categoryCode": "sample string 3",
      "categoryDescription": "sample string 4",
      "accountWn": "sample string 5",
      "accountMa": "sample string 6",
      "amount": 7.0,
      "currency": "sample string 8",
      "exchangeRateDate": "2025-11-08T13:42:51.8713726+01:00",
      "generatingPayment": true,
      "settlement": true,
      "paymentMethod": "sample string 12",
      "deadlineDate": "2025-11-08T13:42:51.8713726+01:00"
    },
    {
      "id": 1,
      "customerCode": "sample string 2",
      "categoryCode": "sample string 3",
      "categoryDescription": "sample string 4",
      "accountWn": "sample string 5",
      "accountMa": "sample string 6",
      "amount": 7.0,
      "currency": "sample string 8",
      "exchangeRateDate": "2025-11-08T13:42:51.8713726+01:00",
      "generatingPayment": true,
      "settlement": true,
      "paymentMethod": "sample string 12",
      "deadlineDate": "2025-11-08T13:42:51.8713726+01:00"
    }
  ],
  "companyData": {
    "companyName": "sample string 1",
    "databaseName": "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/WebApiOptima_v._2._0.Models">
  <accountingId>sample string 2</accountingId>
  <businessTransactionAmount>10</businessTransactionAmount>
  <categoryDescription>sample string 8</categoryDescription>
  <companyData>
    <companyName>sample string 1</companyName>
    <databaseName>sample string 2</databaseName>
  </companyData>
  <documentNumber>sample string 4</documentNumber>
  <elements>
    <JournalItem>
      <accountMa>sample string 6</accountMa>
      <accountWn>sample string 5</accountWn>
      <amount>7</amount>
      <categoryCode>sample string 3</categoryCode>
      <categoryDescription>sample string 4</categoryDescription>
      <currency>sample string 8</currency>
      <customerCode>sample string 2</customerCode>
      <deadlineDate>2025-11-08T13:42:51.8713726+01:00</deadlineDate>
      <exchangeRateDate>2025-11-08T13:42:51.8713726+01:00</exchangeRateDate>
      <generatingPayment>true</generatingPayment>
      <id>1</id>
      <paymentMethod>sample string 12</paymentMethod>
      <settlement>true</settlement>
    </JournalItem>
    <JournalItem>
      <accountMa>sample string 6</accountMa>
      <accountWn>sample string 5</accountWn>
      <amount>7</amount>
      <categoryCode>sample string 3</categoryCode>
      <categoryDescription>sample string 4</categoryDescription>
      <currency>sample string 8</currency>
      <customerCode>sample string 2</customerCode>
      <deadlineDate>2025-11-08T13:42:51.8713726+01:00</deadlineDate>
      <exchangeRateDate>2025-11-08T13:42:51.8713726+01:00</exchangeRateDate>
      <generatingPayment>true</generatingPayment>
      <id>1</id>
      <paymentMethod>sample string 12</paymentMethod>
      <settlement>true</settlement>
    </JournalItem>
  </elements>
  <id>1</id>
  <issueDate>2025-11-08T13:42:51.8713726+01:00</issueDate>
  <journal>sample string 3</journal>
  <operationDate>2025-11-08T13:42:51.8713726+01:00</operationDate>
  <postingDate>2025-11-08T13:42:51.8713726+01:00</postingDate>
  <voucherType>sample string 9</voucherType>
</JournalEntry>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'JournalEntry'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.