Journals

Patch Journals

PATCHhttps://api.sandbox.younium.com/Journals/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Body

application/merge-patch+json

descriptionnullable string

externalERPIdnullable string

transferredToERPnullable string (date-time)

Date of when journal was transferred to external ERP.

Example: "2022-12-03"

Response

200400401403

Success

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Journals/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/merge-patch+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Get Journals by Id

GEThttps://api.sandbox.younium.com/Journals/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Response

200400401403404

Success

Body

application/json

idstring (uuid)

journalNumbernullable string

accountingPeriodnullable all of

journalTypeall of

descriptionnullable string

postedboolean

postedDatenullable string (date-time)

vouchersnullable array of VoucherResponse (object)

Obsolete naming, Same entity as accounting transactions

externalERPIdnullable string

transferredToERPnullable string (date-time)

Date of when journal was transferred to external ERP.

Example: "2022-12-03"

createdstring (date-time)

modifiedstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Journals/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "journalNumber": "text",
  "accountingPeriod": {
    "description": "text",
    "fiscalYear": 0,
    "fiscalPeriod": 0,
    "fiscalQuarter": 0,
    "calendarYear": 0,
    "calendarMonth": 0,
    "startDate": "2024-12-22T11:41:01.772Z",
    "endDate": "2024-12-22T11:41:01.772Z",
    "status": {},
    "closedDate": "2024-12-22T11:41:01.772Z"
  },
  "journalType": {},
  "description": "text",
  "posted": false,
  "postedDate": "2024-12-22T11:41:01.772Z",
  "vouchers": [
    {
      "transactionNumber": "text",
      "effectiveDate": "2024-12-22T11:41:01.772Z",
      "source": {},
      "transactions": [
        {
          "description": "text",
          "account": "text",
          "debitAmount": 0,
          "creditAmount": 0
        }
      ],
      "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": "2024-12-22T11:41:01.772Z",
      "modified": "2024-12-22T11:41:01.772Z"
    }
  ],
  "externalERPId": "text",
  "transferredToERP": "2022-12-03",
  "created": "2024-12-22T11:41:01.772Z",
  "modified": "2024-12-22T11:41:01.772Z"
}

Get Accounting Transactions by Fiscal Year

Get Accounting transactions by fiscal year.

GEThttps://api.sandbox.younium.com/Journals/AccountingTransactions/{year}

Authorization

oauth2

Path parameters

year*integer (int32)

Query parameters

Header parameters

Response

200400401403

Success

Body

application/json

pageNumberinteger (int32)

pageSizeinteger (int32)

totalPagesnullable integer (int32)

totalCountinteger (int32)

nextPagenullable string (uri)

previousPagenullable string (uri)

firstPagenullable string (uri)

lastPagenullable string (uri)

datanullable array of AccountingTransactionResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Journals/AccountingTransactions/{year}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "pageNumber": 0,
  "pageSize": 0,
  "totalPages": 0,
  "totalCount": 0,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com",
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "data": [
    {
      "transactionNumber": "text",
      "effectiveDate": "2024-12-22T11:41:01.772Z",
      "source": {},
      "transactions": [
        {
          "description": "text",
          "account": "text",
          "debitAmount": 0,
          "creditAmount": 0
        }
      ],
      "orderChargeNumber": "text",
      "orderChargeId": "123e4567-e89b-12d3-a456-426614174000",
      "revenueScheduleItemId": "123e4567-e89b-12d3-a456-426614174000",
      "invoice": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceNumber": "text",
        "status": {},
        "notes": "text",
        "invoiceDate": "2024-12-22T11:41:01.772Z",
        "currency": "text",
        "subtotal": 0,
        "tax": 0,
        "totalAmount": 0,
        "settledAmount": 0,
        "taxIncluded": false,
        "invoiceBatchId": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceType": {},
        "externalERPId": "text",
        "externalCRMId": "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",
      "invoiceAccount": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "accountNumber": "text",
        "accountType": {},
        "invoiceDeliveryMethod": {},
        "name": "text",
        "organizationNumber": "text",
        "accountsReceivable": "text",
        "currencyCode": "text",
        "taxRegistrationNumber": "text",
        "taxTemplate": "text",
        "invoiceBatchGroupId": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceSettingGroupId": "123e4567-e89b-12d3-a456-426614174000",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "journalId": "123e4567-e89b-12d3-a456-426614174000",
      "externalERPId": "text",
      "externalCRMId": "text",
      "created": "2024-12-22T11:41:01.772Z",
      "modified": "2024-12-22T11:41:01.772Z"
    }
  ]
}

Get Accounting Transactions by Fiscal Period

Get Accounting transactions by fiscal year and period.

GEThttps://api.sandbox.younium.com/Journals/AccountingTransactions/{year}/FiscalPeriod/{period}

Authorization

oauth2

Path parameters

year*integer (int32)

period*integer (int32)

Query parameters

Header parameters

Response

200400401403

Success

Body

application/json

pageNumberinteger (int32)

pageSizeinteger (int32)

totalPagesnullable integer (int32)

totalCountinteger (int32)

nextPagenullable string (uri)

previousPagenullable string (uri)

firstPagenullable string (uri)

lastPagenullable string (uri)

datanullable array of AccountingTransactionResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Journals/AccountingTransactions/{year}/FiscalPeriod/{period}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "pageNumber": 0,
  "pageSize": 0,
  "totalPages": 0,
  "totalCount": 0,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com",
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "data": [
    {
      "transactionNumber": "text",
      "effectiveDate": "2024-12-22T11:41:01.772Z",
      "source": {},
      "transactions": [
        {
          "description": "text",
          "account": "text",
          "debitAmount": 0,
          "creditAmount": 0
        }
      ],
      "orderChargeNumber": "text",
      "orderChargeId": "123e4567-e89b-12d3-a456-426614174000",
      "revenueScheduleItemId": "123e4567-e89b-12d3-a456-426614174000",
      "invoice": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceNumber": "text",
        "status": {},
        "notes": "text",
        "invoiceDate": "2024-12-22T11:41:01.772Z",
        "currency": "text",
        "subtotal": 0,
        "tax": 0,
        "totalAmount": 0,
        "settledAmount": 0,
        "taxIncluded": false,
        "invoiceBatchId": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceType": {},
        "externalERPId": "text",
        "externalCRMId": "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",
      "invoiceAccount": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "accountNumber": "text",
        "accountType": {},
        "invoiceDeliveryMethod": {},
        "name": "text",
        "organizationNumber": "text",
        "accountsReceivable": "text",
        "currencyCode": "text",
        "taxRegistrationNumber": "text",
        "taxTemplate": "text",
        "invoiceBatchGroupId": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceSettingGroupId": "123e4567-e89b-12d3-a456-426614174000",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "journalId": "123e4567-e89b-12d3-a456-426614174000",
      "externalERPId": "text",
      "externalCRMId": "text",
      "created": "2024-12-22T11:41:01.772Z",
      "modified": "2024-12-22T11:41:01.772Z"
    }
  ]
}

Get Accounting Transactions by Fiscal Quarter

Get Accounting transactions by fiscal year and quarter.

GEThttps://api.sandbox.younium.com/Journals/AccountingTransactions/{year}/FiscalQuarter/{quarter}

Authorization

oauth2

Path parameters

year*integer (int32)

quarter*integer (int32)

Query parameters

Header parameters

Response

200400401403

Success

Body

application/json

pageNumberinteger (int32)

pageSizeinteger (int32)

totalPagesnullable integer (int32)

totalCountinteger (int32)

nextPagenullable string (uri)

previousPagenullable string (uri)

firstPagenullable string (uri)

lastPagenullable string (uri)

datanullable array of AccountingTransactionResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Journals/AccountingTransactions/{year}/FiscalQuarter/{quarter}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "pageNumber": 0,
  "pageSize": 0,
  "totalPages": 0,
  "totalCount": 0,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com",
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "data": [
    {
      "transactionNumber": "text",
      "effectiveDate": "2024-12-22T11:41:01.772Z",
      "source": {},
      "transactions": [
        {
          "description": "text",
          "account": "text",
          "debitAmount": 0,
          "creditAmount": 0
        }
      ],
      "orderChargeNumber": "text",
      "orderChargeId": "123e4567-e89b-12d3-a456-426614174000",
      "revenueScheduleItemId": "123e4567-e89b-12d3-a456-426614174000",
      "invoice": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceNumber": "text",
        "status": {},
        "notes": "text",
        "invoiceDate": "2024-12-22T11:41:01.772Z",
        "currency": "text",
        "subtotal": 0,
        "tax": 0,
        "totalAmount": 0,
        "settledAmount": 0,
        "taxIncluded": false,
        "invoiceBatchId": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceType": {},
        "externalERPId": "text",
        "externalCRMId": "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",
      "invoiceAccount": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "accountNumber": "text",
        "accountType": {},
        "invoiceDeliveryMethod": {},
        "name": "text",
        "organizationNumber": "text",
        "accountsReceivable": "text",
        "currencyCode": "text",
        "taxRegistrationNumber": "text",
        "taxTemplate": "text",
        "invoiceBatchGroupId": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceSettingGroupId": "123e4567-e89b-12d3-a456-426614174000",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "journalId": "123e4567-e89b-12d3-a456-426614174000",
      "externalERPId": "text",
      "externalCRMId": "text",
      "created": "2024-12-22T11:41:01.772Z",
      "modified": "2024-12-22T11:41:01.772Z"
    }
  ]
}

Get Accounting Transactions by fiscal year and Financial Accounts

GEThttps://api.sandbox.younium.com/Journals/AccountingTransactions/{year}/FinancialAccounts/{financialAccount}

Authorization

oauth2

Path parameters

year*integer (int32)

financialAccount*string

Code or Id

Query parameters

Header parameters

Response

200400401403

Success

Body

application/json

pageNumberinteger (int32)

pageSizeinteger (int32)

totalPagesnullable integer (int32)

totalCountinteger (int32)

nextPagenullable string (uri)

previousPagenullable string (uri)

firstPagenullable string (uri)

lastPagenullable string (uri)

datanullable array of AccountingTransactionResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Journals/AccountingTransactions/{year}/FinancialAccounts/{financialAccount}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "pageNumber": 0,
  "pageSize": 0,
  "totalPages": 0,
  "totalCount": 0,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com",
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "data": [
    {
      "transactionNumber": "text",
      "effectiveDate": "2024-12-22T11:41:01.772Z",
      "source": {},
      "transactions": [
        {
          "description": "text",
          "account": "text",
          "debitAmount": 0,
          "creditAmount": 0
        }
      ],
      "orderChargeNumber": "text",
      "orderChargeId": "123e4567-e89b-12d3-a456-426614174000",
      "revenueScheduleItemId": "123e4567-e89b-12d3-a456-426614174000",
      "invoice": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceNumber": "text",
        "status": {},
        "notes": "text",
        "invoiceDate": "2024-12-22T11:41:01.772Z",
        "currency": "text",
        "subtotal": 0,
        "tax": 0,
        "totalAmount": 0,
        "settledAmount": 0,
        "taxIncluded": false,
        "invoiceBatchId": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceType": {},
        "externalERPId": "text",
        "externalCRMId": "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",
      "invoiceAccount": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "accountNumber": "text",
        "accountType": {},
        "invoiceDeliveryMethod": {},
        "name": "text",
        "organizationNumber": "text",
        "accountsReceivable": "text",
        "currencyCode": "text",
        "taxRegistrationNumber": "text",
        "taxTemplate": "text",
        "invoiceBatchGroupId": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceSettingGroupId": "123e4567-e89b-12d3-a456-426614174000",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "journalId": "123e4567-e89b-12d3-a456-426614174000",
      "externalERPId": "text",
      "externalCRMId": "text",
      "created": "2024-12-22T11:41:01.772Z",
      "modified": "2024-12-22T11:41:01.772Z"
    }
  ]
}

Get Accounting Transactions by Journal Id

GEThttps://api.sandbox.younium.com/Journals/{id}/AccountingTransactions

Authorization

oauth2

Path parameters

id*string (uuid)

Query parameters

Header parameters

Response

200400401403

Success

Body

application/json

pageNumberinteger (int32)

pageSizeinteger (int32)

totalPagesnullable integer (int32)

totalCountinteger (int32)

nextPagenullable string (uri)

previousPagenullable string (uri)

firstPagenullable string (uri)

lastPagenullable string (uri)

datanullable array of AccountingTransactionResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Journals/{id}/AccountingTransactions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "pageNumber": 0,
  "pageSize": 0,
  "totalPages": 0,
  "totalCount": 0,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com",
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "data": [
    {
      "transactionNumber": "text",
      "effectiveDate": "2024-12-22T11:41:01.772Z",
      "source": {},
      "transactions": [
        {
          "description": "text",
          "account": "text",
          "debitAmount": 0,
          "creditAmount": 0
        }
      ],
      "orderChargeNumber": "text",
      "orderChargeId": "123e4567-e89b-12d3-a456-426614174000",
      "revenueScheduleItemId": "123e4567-e89b-12d3-a456-426614174000",
      "invoice": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceNumber": "text",
        "status": {},
        "notes": "text",
        "invoiceDate": "2024-12-22T11:41:01.772Z",
        "currency": "text",
        "subtotal": 0,
        "tax": 0,
        "totalAmount": 0,
        "settledAmount": 0,
        "taxIncluded": false,
        "invoiceBatchId": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceType": {},
        "externalERPId": "text",
        "externalCRMId": "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",
      "invoiceAccount": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "accountNumber": "text",
        "accountType": {},
        "invoiceDeliveryMethod": {},
        "name": "text",
        "organizationNumber": "text",
        "accountsReceivable": "text",
        "currencyCode": "text",
        "taxRegistrationNumber": "text",
        "taxTemplate": "text",
        "invoiceBatchGroupId": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceSettingGroupId": "123e4567-e89b-12d3-a456-426614174000",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "journalId": "123e4567-e89b-12d3-a456-426614174000",
      "externalERPId": "text",
      "externalCRMId": "text",
      "created": "2024-12-22T11:41:01.772Z",
      "modified": "2024-12-22T11:41:01.772Z"
    }
  ]
}

Get Journals

GEThttps://api.sandbox.younium.com/Journals

Authorization

oauth2

Query parameters

Header parameters

Response

200400401403

Success

Body

application/json

pageNumberinteger (int32)

pageSizeinteger (int32)

totalPagesnullable integer (int32)

totalCountinteger (int32)

nextPagenullable string (uri)

previousPagenullable string (uri)

firstPagenullable string (uri)

lastPagenullable string (uri)

datanullable array of JournalResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Journals', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "pageNumber": 0,
  "pageSize": 0,
  "totalPages": 0,
  "totalCount": 0,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com",
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "journalNumber": "text",
      "accountingPeriod": {
        "description": "text",
        "fiscalYear": 0,
        "fiscalPeriod": 0,
        "fiscalQuarter": 0,
        "calendarYear": 0,
        "calendarMonth": 0,
        "startDate": "2024-12-22T11:41:01.772Z",
        "endDate": "2024-12-22T11:41:01.772Z",
        "status": {},
        "closedDate": "2024-12-22T11:41:01.772Z"
      },
      "journalType": {},
      "description": "text",
      "posted": false,
      "postedDate": "2024-12-22T11:41:01.772Z",
      "vouchers": [
        {
          "transactionNumber": "text",
          "effectiveDate": "2024-12-22T11:41:01.772Z",
          "source": {},
          "transactions": [
            {
              "description": "text",
              "account": "text",
              "debitAmount": 0,
              "creditAmount": 0
            }
          ],
          "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": "2024-12-22T11:41:01.772Z",
          "modified": "2024-12-22T11:41:01.772Z"
        }
      ],
      "externalERPId": "text",
      "transferredToERP": "2022-12-03",
      "created": "2024-12-22T11:41:01.772Z",
      "modified": "2024-12-22T11:41:01.772Z"
    }
  ]
}

---