Journals

Get Journals by Id

get

Required scopes

This endpoint requires the following scopes:

• : Access Younium API

Authorizations

oauth2

OAuth2passwordRequired

Token URL:

Path parameters

idstring · uuidRequired

The Journal identifier

Header parameters

api-versionstringOptional

Responses

200

Success

application/json

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

404

Not Found

application/json

get

/Journals/{id}

HTTPcURLJavaScriptPython

GET /Journals/{id} HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "journalNumber": "text",
  "accountingPeriod": {
    "description": "text",
    "fiscalYear": 1,
    "fiscalPeriod": 1,
    "fiscalQuarter": 1,
    "calendarYear": 1,
    "calendarMonth": 1,
    "startDate": "2025-12-12T23:55:44.348Z",
    "endDate": "2025-12-12T23:55:44.348Z",
    "status": "Open",
    "closedDate": "2025-12-12T23:55:44.348Z"
  },
  "journalType": "Invoice",
  "description": "text",
  "posted": true,
  "postedDate": "2025-12-12T23:55:44.348Z",
  "vouchers": [
    {
      "transactionNumber": "text",
      "effectiveDate": "2025-12-12T23:55:44.348Z",
      "source": "Invoicing",
      "transactions": [
        {
          "description": "text",
          "account": "text",
          "debitAmount": 1,
          "creditAmount": 1,
          "salesCurrencyDebitAmount": 1,
          "salesCurrencyCreditAmount": 1,
          "salesCurrency": "text",
          "exchangeRate": 1,
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        }
      ],
      "orderChargeNumber": "text",
      "orderChargeId": "123e4567-e89b-12d3-a456-426614174000",
      "revenueScheduleItemId": "123e4567-e89b-12d3-a456-426614174000",
      "invoiceNumber": "text",
      "invoiceAccountId": "123e4567-e89b-12d3-a456-426614174000",
      "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
      "invoiceLineId": "123e4567-e89b-12d3-a456-426614174000",
      "paymentId": "123e4567-e89b-12d3-a456-426614174000",
      "paymentSettlementId": "123e4567-e89b-12d3-a456-426614174000",
      "externalERPId": "text",
      "externalCRMId": "text",
      "created": "2025-12-12T23:55:44.348Z",
      "modified": "2025-12-12T23:55:44.348Z"
    }
  ],
  "externalERPId": "text",
  "transferredToERP": "2022-12-03",
  "created": "2025-12-12T23:55:44.348Z",
  "modified": "2025-12-12T23:55:44.348Z"
}

Patch Journals

patch

Required scopes

This endpoint requires the following scopes:

• : Access Younium API

Authorizations

oauth2

OAuth2passwordRequired

Token URL:

Path parameters

idstring · uuidRequired

Header parameters

api-versionstringOptional

Body

application/merge-patch+json

descriptionstring | nullableOptional

externalERPIdstring | nullableOptional

transferredToERPstring · date-time | nullableOptional

Date of when journal was transferred to external ERP.

Example: 2022-12-03

Responses

200

Success

No content

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

patch

/Journals/{id}

HTTPcURLJavaScriptPython

PATCH /Journals/{id} HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/merge-patch+json
Accept: */*
Content-Length: 77

{
  "description": "text",
  "externalERPId": "text",
  "transferredToERP": "2022-12-03"
}

No content

get

Required scopes

This endpoint requires the following scopes:

• : Access Younium API

Authorizations

oauth2

OAuth2passwordRequired

Token URL:

Query parameters

Skipinteger · int32Optional

Skip number of records

Example: 10

Takeinteger · int32Optional

Take number of records

Example: 5

FilterstringOptional

Filter the resulsts. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20

SortstringOptional

Sorting the results. See ODATA specificaion for more information

Example: name

Header parameters

api-versionstringOptional

Responses

200

Success

application/json

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

get

/Journals

HTTPcURLJavaScriptPython

GET /Journals HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "journalNumber": "text",
    "accountingPeriod": {
      "description": "text",
      "fiscalYear": 1,
      "fiscalPeriod": 1,
      "fiscalQuarter": 1,
      "calendarYear": 1,
      "calendarMonth": 1,
      "startDate": "2025-12-12T23:55:44.348Z",
      "endDate": "2025-12-12T23:55:44.348Z",
      "status": "Open",
      "closedDate": "2025-12-12T23:55:44.348Z"
    },
    "journalType": "Invoice",
    "description": "text",
    "posted": true,
    "postedDate": "2025-12-12T23:55:44.348Z",
    "vouchers": [
      {
        "transactionNumber": "text",
        "effectiveDate": "2025-12-12T23:55:44.348Z",
        "source": "Invoicing",
        "transactions": [
          {
            "description": "text",
            "account": "text",
            "debitAmount": 1,
            "creditAmount": 1,
            "salesCurrencyDebitAmount": 1,
            "salesCurrencyCreditAmount": 1,
            "salesCurrency": "text",
            "exchangeRate": 1,
            "customFields": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          }
        ],
        "orderChargeNumber": "text",
        "orderChargeId": "123e4567-e89b-12d3-a456-426614174000",
        "revenueScheduleItemId": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceNumber": "text",
        "invoiceAccountId": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceLineId": "123e4567-e89b-12d3-a456-426614174000",
        "paymentId": "123e4567-e89b-12d3-a456-426614174000",
        "paymentSettlementId": "123e4567-e89b-12d3-a456-426614174000",
        "externalERPId": "text",
        "externalCRMId": "text",
        "created": "2025-12-12T23:55:44.348Z",
        "modified": "2025-12-12T23:55:44.348Z"
      }
    ],
    "externalERPId": "text",
    "transferredToERP": "2022-12-03",
    "created": "2025-12-12T23:55:44.348Z",
    "modified": "2025-12-12T23:55:44.348Z"
  }
]

---