sprAmountsJournals

  • Updated on Mar 31, 2025
  • Published on Oct 8, 2023
Prev Next

Represents amounts journal (spr) in Business Central.

Methods

Method Return Type Description
GET sprAmountsJournals sprAmountsJournals Gets a amounts journal object.
DELETE sprAmountsJournals none Deletes a amounts journal object.
POST sprAmountsJournals sprAmountsJournals Creates a amounts journal object.
PATCH sprAmountsJournals sprAmountsJournals Updates a amounts journal object.

Bound Actions

The journal resource type offers a bound actions:

  1. post which posts the corresponding journal batch. This is illustrated in the following example: POST ..companies({id})/sprAmountsJournals({id})/Microsoft.NAV.post The response has no content; the response code is 204.
  2. deleteJournalLines which deletes corresponding journal batch's lines. This is illustrated in the following example: POST ..companies({id})/sprAmountsJournals({id})/Microsoft.NAV.deleteJournalLines The response has no content; the response code is 204.

Navigation

Navigation Return Type Description
sprAmountsJournalLines sprAmountsJournalLines Gets the amounts journal lines of the journal.

Properties

Property Type Description Relation to
id GUID Specifies the amount journal's ID. Non-editable.
name String[10] Specifies the amount journal's name.
description String[50] Specifies the amount journal's description.
lastModifiedDateTime DateTimeOffset Specifies the amount journal's last modified date. Read-Only.

Examples

Create sprAmountsJournals

POST URI: /companies({{companyId}})/sprAmountsJournals

Request

{
    "name": "JNL01",
    "description": "Journal 01"
}

Response

{
    "@odata.context": "http://bc220-2:7048/BC/api/softera/softeraPayroll/v1.0/$metadata#companies(fb9142f3-361f-ee11-a396-ce5b49aea574)/sprAmountsJournals/$entity",
    "@odata.etag": "W/\"JzIwOzE0NTM2ODc5NjkzNTI2NTIwODAwMTswMDsn\"",
    "id": "4c8d86fc-975b-ee11-9d1d-a842c56ed966",
    "name": "JNL01",
    "description": "Journal 01",
    "lastModifiedDateTime": "2023-09-25T11:38:03.997Z"
}

Create sprAmountsJournals with sprAmountsJournalLines, sprDimensionSetLines at once

POST URI: /companies({{companyId}})/sprAmountsJournals?$expand=sprAmountsJournalLines($expand=sprDimensionSetLines)

Request

{
    "name": "JNL02",
    "description": "Journal 02",
    "sprAmountsJournalLines" : [
        {
            "employeeId": "{{employeeId}}",
            "employeeNumber": "{{employeeNumber}}",
            "edId": "{{edId}}",
            "edCode": "{{edCode}}",
            "month": "2023-08-31",
            "amountType": "Gross",
            "amount": 101.99,
            "amountPct": 0,
            "inPropToWorkingTime": false,
            "sprDimensionSetLines" : [
                {
                    "code": "PADALINYS",
                    "valueCode": "ADM"
                },
                {
                    "code": "PROJEKTAS",
                    "valueCode": "PRJ01"
                }
            ]
        },
        {
            "employeeId": "{{employeeId}}",
            "employeeNumber": "{{employeeNumber}}",
            "edId": "{{edId}}",
            "edCode": "{{edCode}}",
            "month": "2023-08-31",
            "amountType": "Gross",
            "amount": 202.99,
            "amountPct": 0,
            "inPropToWorkingTime": false,
            "sprDimensionSetLines" : [
                {
                    "code": "PADALINYS",
                    "valueCode": "ADM"
                },
                {
                    "code": "PROJEKTAS",
                    "valueCode": "PRJ01"
                }
            ]
        },
        {
            "employeeId": "{{employeeId}}",
            "employeeNumber": "{{employeeNumber}}",
            "edId": "{{edId}}",
            "edCode": "{{edCode}}",
            "month": "2023-08-31",
            "amountType": "Gross",
            "amount": 303.99,
            "amountPct": 0,
            "inPropToWorkingTime": false,
            "sprDimensionSetLines" : [
                {
                    "code": "PADALINYS",
                    "valueCode": "ADM"
                },
                {
                    "code": "PROJEKTAS",
                    "valueCode": "PRJ01"
                }
            ]
        }
    ]
}

Response

{
    "@odata.context": "http://bc220-2:7048/BC/api/softera/softeraPayroll/v1.0/$metadata#companies(fb9142f3-361f-ee11-a396-ce5b49aea574)/sprAmountsJournals/$entity",
    "@odata.etag": "W/\"JzIwOzE0NTM3MjM3ODY4OTMxMTc4ODM3MTswMDsn\"",
    "id": "1e7f3d95-9a5b-ee11-9d1d-a842c56ed966",
    "name": "JNL02",
    "description": "Journal 02",
    "lastModifiedDateTime": "2023-09-25T11:56:39.21Z",
    "sprAmountsJournalLines": [
        {
            "@odata.etag": "W/\"JzE5OzkxNDM2NzYwOTUwMDA2MDg0NzcxOzAwOyc=\"",
            "id": "1f7f3d95-9a5b-ee11-9d1d-a842c56ed966",
            "journalId": "1e7f3d95-9a5b-ee11-9d1d-a842c56ed966",
            "journalName": "JNL02",
            "lineNo": 10000,
            "employeeId": "32955c7d-381f-ee11-a396-ce5b49aea574",
            "employeeNumber": "D0001",
            "firstName": "Pirmas",
            "surname": "Pirmokas",
            "edId": "28660e59-381f-ee11-a396-ce5b49aea574",
            "edCode": "PRD BEND",
            "edType": "Earnings",
            "description": "Priedas bendras",
            "month": "2023-08-31",
            "amountType": "Gross",
            "amount": 101.99,
            "amountPct": 0,
            "inPropToWorkingTime": false,
            "lastModifiedDateTime": "2023-09-25T11:56:39.217Z",
            "sprDimensionSetLines": [
                {
                    "@odata.etag": "W/\"JzE4OzgwNjA5NTQ1MzM4NTgyMTIwMDE7MDA7Jw==\"",
                    "parentId": "1f7f3d95-9a5b-ee11-9d1d-a842c56ed966",
                    "id": "0af7bfaf-4243-ee11-bfb9-d3640da8a4fa",
                    "code": "PADALINYS",
                    "parentType": "Amounts Journal Line",
                    "displayName": "Padalinys",
                    "valueId": "b20a5ed1-4243-ee11-bfb9-d3640da8a4fa",
                    "valueCode": "ADM",
                    "valueDisplayName": "Administracija"
                },
                {
                    "@odata.etag": "W/\"JzIwOzE3Njg2ODM1NzM3MjQ1ODg5NDcwMTswMDsn\"",
                    "parentId": "1f7f3d95-9a5b-ee11-9d1d-a842c56ed966",
                    "id": "0bf7bfaf-4243-ee11-bfb9-d3640da8a4fa",
                    "code": "PROJEKTAS",
                    "parentType": "Amounts Journal Line",
                    "displayName": "Projektas",
                    "valueId": "9e716ef9-4243-ee11-bfb9-d3640da8a4fa",
                    "valueCode": "PRJ01",
                    "valueDisplayName": ""
                }
            ]
        },
        {
            "@odata.etag": "W/\"JzE5OzQ4NzI2OTMwMzQ4OTA5NTMzMzUxOzAwOyc=\"",
            "id": "207f3d95-9a5b-ee11-9d1d-a842c56ed966",
            "journalId": "1e7f3d95-9a5b-ee11-9d1d-a842c56ed966",
            "journalName": "JNL02",
            "lineNo": 20000,
            "employeeId": "32955c7d-381f-ee11-a396-ce5b49aea574",
            "employeeNumber": "D0001",
            "firstName": "Pirmas",
            "surname": "Pirmokas",
            "edId": "28660e59-381f-ee11-a396-ce5b49aea574",
            "edCode": "PRD BEND",
            "edType": "Earnings",
            "description": "Priedas bendras",
            "month": "2023-08-31",
            "amountType": "Gross",
            "amount": 202.99,
            "amountPct": 0,
            "inPropToWorkingTime": false,
            "lastModifiedDateTime": "2023-09-25T11:56:39.227Z",
            "sprDimensionSetLines": [
                {
                    "@odata.etag": "W/\"JzE5OzIxNzA1NTM2NjE3ODE2MzA5OTIxOzAwOyc=\"",
                    "parentId": "207f3d95-9a5b-ee11-9d1d-a842c56ed966",
                    "id": "0af7bfaf-4243-ee11-bfb9-d3640da8a4fa",
                    "code": "PADALINYS",
                    "parentType": "Amounts Journal Line",
                    "displayName": "Padalinys",
                    "valueId": "b20a5ed1-4243-ee11-bfb9-d3640da8a4fa",
                    "valueCode": "ADM",
                    "valueDisplayName": "Administracija"
                },
                {
                    "@odata.etag": "W/\"JzE4OzYwNDU0OTg3MTkzMjE0NzY0NjE7MDA7Jw==\"",
                    "parentId": "207f3d95-9a5b-ee11-9d1d-a842c56ed966",
                    "id": "0bf7bfaf-4243-ee11-bfb9-d3640da8a4fa",
                    "code": "PROJEKTAS",
                    "parentType": "Amounts Journal Line",
                    "displayName": "Projektas",
                    "valueId": "9e716ef9-4243-ee11-bfb9-d3640da8a4fa",
                    "valueCode": "PRJ01",
                    "valueDisplayName": ""
                }
            ]
        },
        {
            "@odata.etag": "W/\"JzIwOzEzMDcyMzExNTY5NzM1NDI2ODEwMTswMDsn\"",
            "id": "217f3d95-9a5b-ee11-9d1d-a842c56ed966",
            "journalId": "1e7f3d95-9a5b-ee11-9d1d-a842c56ed966",
            "journalName": "JNL02",
            "lineNo": 30000,
            "employeeId": "32955c7d-381f-ee11-a396-ce5b49aea574",
            "employeeNumber": "D0001",
            "firstName": "Pirmas",
            "surname": "Pirmokas",
            "edId": "28660e59-381f-ee11-a396-ce5b49aea574",
            "edCode": "PRD BEND",
            "edType": "Earnings",
            "description": "Priedas bendras",
            "month": "2023-08-31",
            "amountType": "Gross",
            "amount": 303.99,
            "amountPct": 0,
            "inPropToWorkingTime": false,
            "lastModifiedDateTime": "2023-09-25T11:56:39.233Z",
            "sprDimensionSetLines": [
                {
                    "@odata.etag": "W/\"JzE5OzQyMTE5NjQ3MjcyMjE3NDA1NjAxOzAwOyc=\"",
                    "parentId": "217f3d95-9a5b-ee11-9d1d-a842c56ed966",
                    "id": "0af7bfaf-4243-ee11-bfb9-d3640da8a4fa",
                    "code": "PADALINYS",
                    "parentType": "Amounts Journal Line",
                    "displayName": "Padalinys",
                    "valueId": "b20a5ed1-4243-ee11-bfb9-d3640da8a4fa",
                    "valueCode": "ADM",
                    "valueDisplayName": "Administracija"
                },
                {
                    "@odata.etag": "W/\"JzE5OzI2NDU5NjA5MzczNzIyNTcyMTQxOzAwOyc=\"",
                    "parentId": "217f3d95-9a5b-ee11-9d1d-a842c56ed966",
                    "id": "0bf7bfaf-4243-ee11-bfb9-d3640da8a4fa",
                    "code": "PROJEKTAS",
                    "parentType": "Amounts Journal Line",
                    "displayName": "Projektas",
                    "valueId": "9e716ef9-4243-ee11-bfb9-d3640da8a4fa",
                    "valueCode": "PRJ01",
                    "valueDisplayName": ""
                }
            ]
        }
    ]
}

Update sprAmountsJournals

PATCH URI: /companies({{companyId}})/sprAmountsJournals({{amountsJournalId}})

Request

{
    "name": "JNL03",
    "description": "Journal 03"
}

Response

{
    "@odata.context": "http://bc220-2:7048/BC/api/softera/softeraPayroll/v1.0/$metadata#companies(fb9142f3-361f-ee11-a396-ce5b49aea574)/sprAmountsJournals/$entity",
    "@odata.etag": "W/\"JzIwOzE0NTM2ODgzNDAzNTg0OTI3NTg3MTswMDsn\"",
    "id": "4c8d86fc-975b-ee11-9d1d-a842c56ed966",
    "name": "JNL03",
    "description": "Journal 03",
    "lastModifiedDateTime": "2023-09-25T12:07:43.26Z"
}