Journals

PreviousInvoices NextMeasurements

Last updated 3 months ago

Was this helpful?

Patch Journals

patch

/Journals/{id}

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Body

descriptionstring | nullable

externalERPIdstring | nullable

transferredToERPstring · date-time | nullable

Date of when journal was transferred to external ERP.

Example: 2022-12-03

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.younium.com/Journals/{id}' \
  --header 'Content-Type: application/merge-patch+json' \
  --data '{"transferredToERP":"2022-12-03"}'

200

400

401

403

No body

Success

Get Journals by Id

get

/Journals/{id}

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.younium.com/Journals/{id}'

200

400

401

403

404

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

Success

get

/Journals

Authorizations

Query parameters

Skipinteger · int32

Skip number of records

Example: 10

Takeinteger · int32

Take number of records

Example: 5

Filterstring

Filter the resulsts. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20

Sortstring

Sorting the results. See ODATA specificaion for more information

Example: name

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.younium.com/Journals'

200

400

401

403

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

Success