Younium Developer Portal
  • Welcome
  • Get started
  • API:s
    • API 2.0
      • Accounts
      • Bookings
      • Chartofaccounts
      • Countries
      • Currency
      • Documenttemplate
      • Exchangerate
      • Invoices
      • Journals
      • Measurements
      • Orders
      • Paymentterms
      • Products
      • Quotes
      • Salesorders
      • Simpleproducts
      • Subscriptions
      • Taxtemplates
      • Unitofmeasurements
      • Usage
      • Webhooks
    • API 2.1
      • Accounts
      • Bookings
      • Chartofaccounts
      • Countries
      • Currency
      • Customfieldconfigurations
      • Documenttemplate
      • Exchangerate
      • Invoicebatches
      • Invoicebatchgroups
      • Invoices
      • Journals
      • Measurements
      • Orders
      • Payments
      • Paymentterms
      • Products
      • Quotes
      • Reports
      • Revenueschedule
      • Salesorders
      • Simpleproducts
      • Subscriptions
      • Taxtemplates
      • Unitofmeasurements
      • Usage
      • Webhooks
  • Documentation
    • Developer resources
    • Invoice operations
    • Product guide
    • Webhooks
    • Idempotent requests
  • Sandbox
Powered by GitBook
On this page
  • GETGet Journals by Id
  • PATCHPatch Journals
  • GET/Journals

Was this helpful?

  1. API:s
  2. API 2.0

Journals

PreviousInvoicesNextMeasurements

Last updated 1 month ago

Was this helpful?

get
Authorizations
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
get
GET /Journals HTTP/1.1
Host: api.younium.com
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "journalNumber": "text",
    "accountingPeriod": {
      "description": "text",
      "fiscalYear": 1,
      "fiscalPeriod": 1,
      "fiscalQuarter": 1,
      "calendarYear": 1,
      "calendarMonth": 1,
      "startDate": "2025-04-27T17:47:51.169Z",
      "endDate": "2025-04-27T17:47:51.169Z",
      "status": "Open",
      "closedDate": "2025-04-27T17:47:51.169Z"
    },
    "journalType": "Invoice",
    "description": "text",
    "posted": true,
    "postedDate": "2025-04-27T17:47:51.169Z",
    "vouchers": [
      {
        "transactionNumber": "text",
        "effectiveDate": "2025-04-27T17:47:51.169Z",
        "source": "Invoicing",
        "transactions": [
          {
            "description": "text",
            "account": "text",
            "debitAmount": 1,
            "creditAmount": 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-04-27T17:47:51.169Z",
        "modified": "2025-04-27T17:47:51.169Z"
      }
    ],
    "externalERPId": "text",
    "transferredToERP": "2022-12-03",
    "created": "2025-04-27T17:47:51.169Z",
    "modified": "2025-04-27T17:47:51.169Z"
  }
]

Get Journals by Id

get
Authorizations
Path parameters
idstring · uuidRequired

The Journal identifier

Header parameters
api-versionstringOptional
Responses
get
GET /Journals/{id} HTTP/1.1
Host: api.younium.com
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "journalNumber": "text",
  "accountingPeriod": {
    "description": "text",
    "fiscalYear": 1,
    "fiscalPeriod": 1,
    "fiscalQuarter": 1,
    "calendarYear": 1,
    "calendarMonth": 1,
    "startDate": "2025-04-27T17:47:51.169Z",
    "endDate": "2025-04-27T17:47:51.169Z",
    "status": "Open",
    "closedDate": "2025-04-27T17:47:51.169Z"
  },
  "journalType": "Invoice",
  "description": "text",
  "posted": true,
  "postedDate": "2025-04-27T17:47:51.169Z",
  "vouchers": [
    {
      "transactionNumber": "text",
      "effectiveDate": "2025-04-27T17:47:51.169Z",
      "source": "Invoicing",
      "transactions": [
        {
          "description": "text",
          "account": "text",
          "debitAmount": 1,
          "creditAmount": 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-04-27T17:47:51.169Z",
      "modified": "2025-04-27T17:47:51.169Z"
    }
  ],
  "externalERPId": "text",
  "transferredToERP": "2022-12-03",
  "created": "2025-04-27T17:47:51.169Z",
  "modified": "2025-04-27T17:47:51.169Z"
}

Patch Journals

patch
Authorizations
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
Body
descriptionstring | nullableOptional
externalERPIdstring | nullableOptional
transferredToERPstring · date-time | nullableOptional

Date of when journal was transferred to external ERP.

Example: 2022-12-03
Responses
patch
PATCH /Journals/{id} HTTP/1.1
Host: api.younium.com
Content-Type: application/merge-patch+json
Accept: */*
Content-Length: 77

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