Journal application

Edit the details of a journal application

Activity name: <a href="https://developer.loket.nl/Activities/PatchJournalApplicationByJournalConfigurationId" target="_blank">PatchJournalApplicationByJournalConfigurationId</a>

Edit the details of journal application

Metadata : Possible options for fields of the type 'metadata' can be acquired (GET) by adding /metadata to the POST URL.

patch/v2/providers/employers/payrolladministrations/journalConfigurations/{journalConfigurationId}/journalApplication

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/payrolladministrations/journalConfigurations/{journalConfigurationId}/journalApplication
  • Auth
    none required

Path parameters

journalConfigurationIdstring uuid required

The unique identifier of a journal configuration

Headers

Authorizationstring required
Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

Acceptstring required
Example:application/json;version=2018-01-01

The accept header is used to influence what type of output is returned and in most cases the version of the output

Request body

journalCodestring nullable

DagboekCode

descriptionstring nullable

The description to be send in with the ledger lines

isAutomatedExportEnabledboolean nullable

This field indicates whether journalruns will be exported automaticaly or not

deviatingJournalSeriesstring nullable

Afwijking boekstuk serie

includeCostCenterboolean nullable

Indicates whether cost centers are included in the journal export

includeCostUnitboolean nullable

Indicates whether cost units are included in the journal export

reportVoucherNumberinteger nullable

boekstuknummer

journalNumberinteger nullable

Dagboek

subAdministrationstring nullable

Sub-Administratie

apiKeystring nullable

An API key

allocationstring nullable

Toewijzing

suspenseAccountstring nullable

The "number" for the suspense account (is a string)

Example request

{
  "journalApplication": {
    "key": 1,
    "value": "Precies Online"
  },
  "financialAdministration": {
    "code": "NL-12345",
    "externalValue": "Vesting Den Helder"
  },
  "journalCode": "2",
  "account": {
    "key": 2,
    "value": "Account Jan"
  },
  "description": "General ledger supermarkets",
  "methodForDeterminingAccountingPeriod": {
    "key": 1,
    "value": "Periode eerste dag verloningsperiode"
  },
  "deviatingJournalSeries": "A",
  "linkCostCenterToGroup": {
    "code": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "externalValue": "Vesting Den Helder"
  },
  "linkCostUnitToGroup": {
    "code": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "externalValue": "Vesting Den Helder"
  },
  "includeCostCenter": true,
  "payrollPeriodFinancialPeriodMapping": [
    {
      "payrollPeriodNumber": 1,
      "financialPeriodNumber": 11,
      "financialAndPayrollYearRelation": {
        "key": 1,
        "value": "Payroll Year -1"
      }
    }
  ],
  "credentials": {
    "username": "User123",
    "password": "**********"
  },
  "subAdministration": "General ledger supermarkets salary",
  "allocation": "Salary",
  "suspenseAccount": "SAL-4000"
}

Response

OK

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "journalApplication": {
      "key": 1,
      "value": "Precies Online"
    },
    "financialAdministration": {
      "code": "NL-12345",
      "externalValue": "Vesting Den Helder"
    },
    "journalCode": "2",
    "account": {
      "key": 2,
      "value": "Account Jan"
    },
    "description": "General ledger supermarkets",
    "methodForDeterminingAccountingPeriod": {
      "key": 1,
      "value": "Periode eerste dag verloningsperiode"
    },
    "deviatingJournalSeries": "A",
    "linkCostCenterToGroup": {
      "code": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "externalValue": "Vesting Den Helder"
    },
    "linkCostUnitToGroup": {
      "code": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "externalValue": "Vesting Den Helder"
    },
    "includeCostCenter": true,
    "payrollPeriodFinancialPeriodMapping": [
      {
        "payrollPeriodNumber": 1,
        "financialPeriodNumber": 11,
        "financialAndPayrollYearRelation": {
          "key": 1,
          "value": "Payroll Year -1"
        }
      }
    ],
    "credentials": {
      "username": "User123",
      "password": "**********"
    },
    "subAdministration": "General ledger supermarkets salary",
    "allocation": "Salary",
    "suspenseAccount": "SAL-4000"
  }
}

Changes

No recorded changes to this operation across all 6 revisions of this API.