Updates an object of type journal in Dynamics 365 Business Central

Request

Security

oAuthoauth2 (OAuth 2.0)
OAuth2oauth2 (OAuth 2.0)

Path

company_idstring (uuid)required
(v1.0) id for company

Example: e942a270-62d2-4aef-aa48-6fe3ef9e53e1
journal_idstring (uuid)required
(v1.0) id for journal

Example: e942a270-62d2-4aef-aa48-6fe3ef9e53e1

Headers

Content-Typestringrequired
(v1.0) application/json
If-Matchstringrequired
(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.

Example: true

Body application/json required

idstring (uuid)
(v1.0) The id property for the Dynamics 365 Business Central journal entity

Example: 2a2dfc50-f21b-4ab0-8f89-463efd0dfce4
codestring
(v1.0) The code property for the Dynamics 365 Business Central journal entity

Example:
<= 10 characters
displayNamestring
(v1.0) The displayName property for the Dynamics 365 Business Central journal entity

Example: null
<= 100 characters
lastModifiedDateTimestring (date-time)
(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central journal entity

Example: null
balancingAccountIdstring (uuid)
(v1.0) The balancingAccountId property for the Dynamics 365 Business Central journal entity

Example: null
balancingAccountnumberstring
(v1.0) The balancingAccountNumber property for the Dynamics 365 Business Central journal entity

Example: null
<= 20 characters

Responses

(v1.0) Succesfully updated the specifiedjournal

Body application/json

idstring (uuid)
(v1.0) The id property for the Dynamics 365 Business Central journal entity

Example: 2a2dfc50-f21b-4ab0-8f89-463efd0dfce4
codestring
(v1.0) The code property for the Dynamics 365 Business Central journal entity

Example:
<= 10 characters
displayNamestring
(v1.0) The displayName property for the Dynamics 365 Business Central journal entity

Example: null
<= 100 characters
lastModifiedDateTimestring (date-time)
(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central journal entity

Example: null
balancingAccountIdstring (uuid)
(v1.0) The balancingAccountId property for the Dynamics 365 Business Central journal entity

Example: null
balancingAccountNumberstring
(v1.0) The balancingAccountNumber property for the Dynamics 365 Business Central journal entity

Example: null
<= 20 characters
journalLinesArray of objects (journalLine)
Show 16 properties
- idstring (uuid)
  (v1.0) The id property for the Dynamics 365 Business Central journalLine entity
  
  Example: 2a2dfc50-f21b-4ab0-8f89-463efd0dfce4
- journalDisplayNamestring
  (v1.0) The journalDisplayName property for the Dynamics 365 Business Central journalLine entity
  
  Example: null
- lineNumberinteger (int32)
  (v1.0) The lineNumber property for the Dynamics 365 Business Central journalLine entity
  
  Example: null
- accountTypestring
  (v1.0) The accountType property for the Dynamics 365 Business Central journalLine entity
  
  Example: null
- accountIdstring (uuid)
  (v1.0) The accountId property for the Dynamics 365 Business Central journalLine entity
  
  Example: null
- accountNumberstring
  (v1.0) The accountNumber property for the Dynamics 365 Business Central journalLine entity
  
  Example: null
  <= 20 characters
- postingDatestring (date-time)
  (v1.0) The postingDate property for the Dynamics 365 Business Central journalLine entity
  
  Example: null
- documentNumberstring
  (v1.0) The documentNumber property for the Dynamics 365 Business Central journalLine entity
  
  Example: null
  <= 20 characters
- externalDocumentNumberstring
  (v1.0) The externalDocumentNumber property for the Dynamics 365 Business Central journalLine entity
  
  Example: null
  <= 35 characters
- amountnumber (decimal)
  (v1.0) The amount property for the Dynamics 365 Business Central journalLine entity
  
  Example: null
- descriptionstring
  (v1.0) The description property for the Dynamics 365 Business Central journalLine entity
  
  Example: null
  <= 100 characters
- commentstring
  (v1.0) The comment property for the Dynamics 365 Business Central journalLine entity
  
  Example: null
  <= 250 characters
- dimensionsArray of objects (dimensiontype)
  Show 6 properties
  - codestring
    (v1.0) The code property for the Dynamics 365 Business Central dimensiontype entity
    
    Example: IHBD786BH
  - displayNamestring
    (v1.0) The displayName property for the Dynamics 365 Business Central dimensiontype entity
    
    Example: null
  - dimensionValuesstring
    (v1.0) The displayName property for the Dynamics 365 Business Central dimensiontype entity
    
    Example: [{"id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4", "code": "JKHB9XER3"}]
  - valueCodestring
    (v1.0) The valueCode property for the Dynamics 365 Business Central dimensiontype entity
    
    Example: V9045VJKNJI
  - valueDisplayNamestring
    (v1.0) The valueDisplayName property for the Dynamics 365 Business Central dimensiontype entity
    
    Example: null
  - customerobject (customer)
    Show 25 properties
    idstring (uuid)
    (v1.0) The id property for the Dynamics 365 Business Central customer entity
    
    Example: 2a2dfc50-f21b-4ab0-8f89-463efd0dfce4
    numberstring
    (v1.0) The number property for the Dynamics 365 Business Central customer entity
    
    Example: null
    <= 20 characters
    displayNamestring
    (v1.0) The displayName property for the Dynamics 365 Business Central customer entity
    
    Example:
    <= 100 characters
    typestring
    (v1.0) The type property for the Dynamics 365 Business Central customer entity
    
    Example: null
    phoneNumberstring
    (v1.0) The phoneNumber property for the Dynamics 365 Business Central customer entity
    
    Example: null
    <= 30 characters
    emailstring
    (v1.0) The email property for the Dynamics 365 Business Central customer entity
    
    Example: null
    <= 80 characters
    websitestring
    (v1.0) The website property for the Dynamics 365 Business Central customer entity
    
    Example: null
    <= 80 characters
    taxLiableboolean
    (v1.0) The taxLiable property for the Dynamics 365 Business Central customer entity
    
    Example: null
    taxAreaIdstring (uuid)
    (v1.0) The taxAreaId property for the Dynamics 365 Business Central customer entity
    
    Example: null
    taxAreaDisplayNamestring
    (v1.0) The taxAreaDisplayName property for the Dynamics 365 Business Central customer entity
    
    Example: null
    taxRegistrationNumberstring
    (v1.0) The taxRegistrationNumber property for the Dynamics 365 Business Central customer entity
    
    Example: null
    <= 20 characters
    currencyIdstring (uuid)
    (v1.0) The currencyId property for the Dynamics 365 Business Central customer entity
    
    Example: null
    currencyCodestring
    (v1.0) The currencyCode property for the Dynamics 365 Business Central customer entity
    
    Example: null
    paymentTermsIdstring (uuid)
    (v1.0) The paymentTermsId property for the Dynamics 365 Business Central customer entity
    
    Example: null
    shipmentMethodIdstring (uuid)
    (v1.0) The shipmentMethodId property for the Dynamics 365 Business Central customer entity
    
    Example: null
    paymentMethodIdstring (uuid)
    (v1.0) The paymentMethodId property for the Dynamics 365 Business Central customer entity
    
    Example: null
    blockedstring
    (v1.0) The blocked property for the Dynamics 365 Business Central customer entity
    
    Example: null
    lastModifiedDateTimestring (date-time)
    (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central customer entity
    
    Example: null
    customerFinancialDetailsArray of objects (customerFinancialDetail)
    pictureArray of objects (picture)
    defaultDimensionsArray of objects (defaultDimensions)
    currencyobject (currency)
    paymentTermobject (paymentTerm)
    shipmentMethodobject (shipmentMethod)
    paymentMethodobject (paymentMethod)
- lastModifiedDateTimestring (date-time)
  (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central journalLine entity
  
  Example: null
- attachmentsArray of objects (attachments)
  Show 6 properties
  - parentIdstring (uuid)
    (v1.0) The parentId property for the Dynamics 365 Business Central attachments entity
    
    Example: 2a2dfc50-f21b-4ab0-8f89-463efd0dfce4
  - idstring (uuid)
    (v1.0) The id property for the Dynamics 365 Business Central attachments entity
    
    Example: 4g7dfc58-f21b-4ad0-8f39-463efd0gfae8
  - fileNamestring
    (v1.0) The fileName property for the Dynamics 365 Business Central attachments entity
    
    Example: null
    <= 250 characters
  - byteSizeinteger (int32)
    (v1.0) The byteSize property for the Dynamics 365 Business Central attachments entity
    
    Example: null
  - contentstring (binary)
    (v1.0) The content property for the Dynamics 365 Business Central attachments entity
  - lastModifiedDateTimestring (date-time)
    (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central attachments entity
    
    Example: null
- accountobject (account)
  Show 7 properties
  - idstring (uuid)
    (v1.0) The id property for the Dynamics 365 Business Central account entity
    
    Example: 2a2dfc50-f21b-4ab0-8f89-463efd0dfce4
  - numberstring
    (v1.0) The number property for the Dynamics 365 Business Central account entity
    
    Example: null
    <= 20 characters
  - displayNamestring
    (v1.0) The displayName property for the Dynamics 365 Business Central account entity
    
    Example: null
    <= 100 characters
  - categorystring
    (v1.0) The category property for the Dynamics 365 Business Central account entity
    
    Example: null
  - subCategorystring
    (v1.0) The subCategory property for the Dynamics 365 Business Central account entity
    
    Example: null
    <= 80 characters
  - blockedboolean
    (v1.0) The blocked property for the Dynamics 365 Business Central account entity
    
    Example: null
  - lastModifiedDateTimestring (date-time)
    (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central account entity
    
    Example: null
accountobject (account)
Show 7 properties
- idstring (uuid)
  (v1.0) The id property for the Dynamics 365 Business Central account entity
  
  Example: 2a2dfc50-f21b-4ab0-8f89-463efd0dfce4
- numberstring
  (v1.0) The number property for the Dynamics 365 Business Central account entity
  
  Example: null
  <= 20 characters
- displayNamestring
  (v1.0) The displayName property for the Dynamics 365 Business Central account entity
  
  Example: null
  <= 100 characters
- categorystring
  (v1.0) The category property for the Dynamics 365 Business Central account entity
  
  Example: null
- subCategorystring
  (v1.0) The subCategory property for the Dynamics 365 Business Central account entity
  
  Example: null
  <= 80 characters
- blockedboolean
  (v1.0) The blocked property for the Dynamics 365 Business Central account entity
  
  Example: null
- lastModifiedDateTimestring (date-time)
  (v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central account entity
  
  Example: null

patch /companies({company_id})/journals({journal_id})

curl -X PATCH \
  'https://www.beehexa.com/_mock/api/microsoft-dynamics-365-business-central-api/default-built-by-microsoft/companies(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)/journals(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'If-Match: true' \
  -d '{
  "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4",
  "code": "",
  "displayName": null,
  "lastModifiedDateTime": null,
  "balancingAccountId": null,
  "balancingAccountnumber": null
}'

const url = 'https://www.beehexa.com/_mock/api/microsoft-dynamics-365-business-central-api/default-built-by-microsoft/companies(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)/journals(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)';
const options = {
  method: 'PATCH',
  headers: {
    'Content-Type': 'application/json',
    'If-Match': 'true',
    Authorization: 'Bearer <YOUR_TOKEN_HERE>'
  },
  body: '{"id":"2a2dfc50-f21b-4ab0-8f89-463efd0dfce4","code":"","displayName":null,"lastModifiedDateTime":null,"balancingAccountId":null,"balancingAccountnumber":null}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

const fetch = require('node-fetch');

const url = 'https://www.beehexa.com/_mock/api/microsoft-dynamics-365-business-central-api/default-built-by-microsoft/companies(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)/journals(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)';
const options = {
  method: 'PATCH',
  headers: {
    'Content-Type': 'application/json',
    'If-Match': 'true',
    Authorization: 'Bearer <YOUR_TOKEN_HERE>'
  },
  body: '{"id":"2a2dfc50-f21b-4ab0-8f89-463efd0dfce4","code":"","displayName":null,"lastModifiedDateTime":null,"balancingAccountId":null,"balancingAccountnumber":null}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

import requests

url = "https://www.beehexa.com/_mock/api/microsoft-dynamics-365-business-central-api/default-built-by-microsoft/companies(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)/journals(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)"

payload = {
  "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4",
  "code": "",
  "displayName": None,
  "lastModifiedDateTime": None,
  "balancingAccountId": None,
  "balancingAccountnumber": None
}
headers = {
  "Content-Type": "application/json",
  "If-Match": "true",
  "Authorization": "Bearer <YOUR_TOKEN_HERE>"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"id\": \"2a2dfc50-f21b-4ab0-8f89-463efd0dfce4\",\n  \"code\": \"\",\n  \"displayName\": null,\n  \"lastModifiedDateTime\": null,\n  \"balancingAccountId\": null,\n  \"balancingAccountnumber\": null\n}");
Request request = new Request.Builder()
  .url("https://www.beehexa.com/_mock/api/microsoft-dynamics-365-business-central-api/default-built-by-microsoft/companies(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)/journals(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)")
  .patch(body)
  .addHeader("Content-Type", "application/json")
  .addHeader("If-Match", "true")
  .addHeader("Authorization", "Bearer <YOUR_TOKEN_HERE>")
  .build();

Response response = client.newCall(request).execute();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Patch,
  RequestUri = new Uri("https://www.beehexa.com/_mock/api/microsoft-dynamics-365-business-central-api/default-built-by-microsoft/companies(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)/journals(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)"),
  Headers =
  {
    { "If-Match", "true" },
    { "Authorization", "Bearer <YOUR_TOKEN_HERE>" },
  },
  Content = new StringContent("{\n  \"id\": \"2a2dfc50-f21b-4ab0-8f89-463efd0dfce4\",\n  \"code\": \"\",\n  \"displayName\": null,\n  \"lastModifiedDateTime\": null,\n  \"balancingAccountId\": null,\n  \"balancingAccountnumber\": null\n}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.beehexa.com/_mock/api/microsoft-dynamics-365-business-central-api/default-built-by-microsoft/companies(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)/journals(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => '2a2dfc50-f21b-4ab0-8f89-463efd0dfce4',
    'code' => '',
    'displayName' => null,
    'lastModifiedDateTime' => null,
    'balancingAccountId' => null,
    'balancingAccountnumber' => null
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <YOUR_TOKEN_HERE>",
    "Content-Type: application/json",
    "If-Match: true"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.beehexa.com/_mock/api/microsoft-dynamics-365-business-central-api/default-built-by-microsoft/companies(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)/journals(e942a270-62d2-4aef-aa48-6fe3ef9e53e1)"

	payload := strings.NewReader("{\n  \"id\": \"2a2dfc50-f21b-4ab0-8f89-463efd0dfce4\",\n  \"code\": \"\",\n  \"displayName\": null,\n  \"lastModifiedDateTime\": null,\n  \"balancingAccountId\": null,\n  \"balancingAccountnumber\": null\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Content-Type", "application/json")
	req.Header.Add("If-Match", "true")
	req.Header.Add("Authorization", "Bearer <YOUR_TOKEN_HERE>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response

application/json

{
  "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4",
  "code": "",
  "displayName": null,
  "lastModifiedDateTime": null,
  "balancingAccountId": null,
  "balancingAccountNumber": null,
  "journalLines": [
    {
      "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4",
      "journalDisplayName": null,
      "lineNumber": null,
      "accountType": null,
      "accountId": null,
      "accountNumber": null,
      "postingDate": null,
      "documentNumber": null,
      "externalDocumentNumber": null,
      "amount": null,
      "description": null,
      "comment": null,
      "dimensions": [
        null
      ],
      "lastModifiedDateTime": null,
      "attachments": [
        null
      ],
      "account": {}
    }
  ],
  "account": {
    "id": "2a2dfc50-f21b-4ab0-8f89-463efd0dfce4",
    "number": null,
    "displayName": null,
    "category": null,
    "subCategory": null,
    "blocked": null,
    "lastModifiedDateTime": null
  }
}

Updates an object of type journal in Dynamics 365 Business Central

Request

Security

Path

Headers

Body application/json required

Responses200

Body application/json

Responses