Journals
The Journal identifier
GET /Journals/{id} HTTP/1.1
Host: api.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-06-23T09:15:58.654Z",
"endDate": "2025-06-23T09:15:58.654Z",
"status": "Open",
"closedDate": "2025-06-23T09:15:58.654Z"
},
"journalType": "Invoice",
"description": "text",
"posted": true,
"postedDate": "2025-06-23T09:15:58.654Z",
"vouchers": [
{
"transactionNumber": "text",
"effectiveDate": "2025-06-23T09:15:58.654Z",
"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-06-23T09:15:58.654Z",
"modified": "2025-06-23T09:15:58.654Z"
}
],
"externalERPId": "text",
"transferredToERP": "2022-12-03",
"created": "2025-06-23T09:15:58.654Z",
"modified": "2025-06-23T09:15:58.654Z"
}
Date of when journal was transferred to external ERP.
2022-12-03
PATCH /Journals/{id} HTTP/1.1
Host: api.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
Filter the results. See ODATA documentation for more information
name eq 'Adam' and age gt 20
Sorting the results. See ODATA specification for more information
accountNumber Desc
Apply a separate modified After filter. See 'ModifiedBefore' filter for further details.
03/01/2025 00:00:00
Filter is also applied on sub entities: 'vouchers' (accounting transactions), 'transactions' and 'customFields' on transactions
03/01/2025 00:00:00
Page Size
20
Page Number
1
GET /Journals HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"pageNumber": 1,
"pageSize": 1,
"totalPages": 1,
"totalCount": 1,
"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": 1,
"fiscalPeriod": 1,
"fiscalQuarter": 1,
"calendarYear": 1,
"calendarMonth": 1,
"startDate": "2025-06-23T09:15:58.654Z",
"endDate": "2025-06-23T09:15:58.654Z",
"status": "Open",
"closedDate": "2025-06-23T09:15:58.654Z"
},
"journalType": "Invoice",
"description": "text",
"posted": true,
"postedDate": "2025-06-23T09:15:58.654Z",
"vouchers": [
{
"transactionNumber": "text",
"effectiveDate": "2025-06-23T09:15:58.654Z",
"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-06-23T09:15:58.654Z",
"modified": "2025-06-23T09:15:58.654Z"
}
],
"externalERPId": "text",
"transferredToERP": "2022-12-03",
"created": "2025-06-23T09:15:58.654Z",
"modified": "2025-06-23T09:15:58.654Z"
}
]
}
Get Accounting transactions by fiscal year.
Filter the results. See ODATA documentation for more information
name eq 'Adam' and age gt 20
Sorting the results. See ODATA specification for more information
accountNumber Desc
Apply a separate modified After filter. See 'ModifiedBefore' filter for further details.
03/01/2025 00:00:00
Filter is applied on sub entities: transactions and transaction custom fields
03/01/2025 00:00:00
Page Size
20
Page Number
1
GET /Journals/AccountingTransactions/{year} HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"pageNumber": 1,
"pageSize": 1,
"totalPages": 1,
"totalCount": 1,
"nextPage": "https://example.com",
"previousPage": "https://example.com",
"firstPage": "https://example.com",
"lastPage": "https://example.com",
"data": [
{
"transactionNumber": "text",
"effectiveDate": "2025-06-23T09:15:58.654Z",
"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",
"invoice": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"invoiceNumber": "text",
"status": "Draft",
"notes": "text",
"invoiceDate": "2025-06-23T09:15:58.654Z",
"currency": "text",
"subtotal": 1,
"tax": 1,
"totalAmount": 1,
"settledAmount": 1,
"taxIncluded": true,
"invoiceBatchId": "123e4567-e89b-12d3-a456-426614174000",
"invoiceType": "Invoice",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"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": "Customer",
"invoiceDeliveryMethod": "Email",
"name": "text",
"organizationNumber": "text",
"accountsReceivable": "text",
"currencyCode": "text",
"taxRegistrationNumber": "text",
"taxTemplate": "text",
"invoiceBatchGroupId": "123e4567-e89b-12d3-a456-426614174000",
"invoiceSettingGroupId": "123e4567-e89b-12d3-a456-426614174000",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"externalERPId": "text",
"externalCRMId": "text"
},
"journalId": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text",
"created": "2025-06-23T09:15:58.654Z",
"modified": "2025-06-23T09:15:58.654Z"
}
]
}
Get Accounting transactions by fiscal year and period.
Filter the results. See ODATA documentation for more information
name eq 'Adam' and age gt 20
Sorting the results. See ODATA specification for more information
accountNumber Desc
Apply a separate modified After filter. See 'ModifiedBefore' filter for further details.
03/01/2025 00:00:00
Filter is applied on sub entities: transactions and transaction custom fields
03/01/2025 00:00:00
Page Size
20
Page Number
1
GET /Journals/AccountingTransactions/{year}/FiscalPeriod/{period} HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"pageNumber": 1,
"pageSize": 1,
"totalPages": 1,
"totalCount": 1,
"nextPage": "https://example.com",
"previousPage": "https://example.com",
"firstPage": "https://example.com",
"lastPage": "https://example.com",
"data": [
{
"transactionNumber": "text",
"effectiveDate": "2025-06-23T09:15:58.654Z",
"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",
"invoice": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"invoiceNumber": "text",
"status": "Draft",
"notes": "text",
"invoiceDate": "2025-06-23T09:15:58.654Z",
"currency": "text",
"subtotal": 1,
"tax": 1,
"totalAmount": 1,
"settledAmount": 1,
"taxIncluded": true,
"invoiceBatchId": "123e4567-e89b-12d3-a456-426614174000",
"invoiceType": "Invoice",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"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": "Customer",
"invoiceDeliveryMethod": "Email",
"name": "text",
"organizationNumber": "text",
"accountsReceivable": "text",
"currencyCode": "text",
"taxRegistrationNumber": "text",
"taxTemplate": "text",
"invoiceBatchGroupId": "123e4567-e89b-12d3-a456-426614174000",
"invoiceSettingGroupId": "123e4567-e89b-12d3-a456-426614174000",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"externalERPId": "text",
"externalCRMId": "text"
},
"journalId": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text",
"created": "2025-06-23T09:15:58.654Z",
"modified": "2025-06-23T09:15:58.654Z"
}
]
}
Get Accounting transactions by fiscal year and quarter.
Filter the results. See ODATA documentation for more information
name eq 'Adam' and age gt 20
Sorting the results. See ODATA specification for more information
accountNumber Desc
Apply a separate modified After filter. See 'ModifiedBefore' filter for further details.
03/01/2025 00:00:00
Filter is applied on sub entities: transactions and transaction custom fields
03/01/2025 00:00:00
Page Size
20
Page Number
1
GET /Journals/AccountingTransactions/{year}/FiscalQuarter/{quarter} HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"pageNumber": 1,
"pageSize": 1,
"totalPages": 1,
"totalCount": 1,
"nextPage": "https://example.com",
"previousPage": "https://example.com",
"firstPage": "https://example.com",
"lastPage": "https://example.com",
"data": [
{
"transactionNumber": "text",
"effectiveDate": "2025-06-23T09:15:58.654Z",
"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",
"invoice": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"invoiceNumber": "text",
"status": "Draft",
"notes": "text",
"invoiceDate": "2025-06-23T09:15:58.654Z",
"currency": "text",
"subtotal": 1,
"tax": 1,
"totalAmount": 1,
"settledAmount": 1,
"taxIncluded": true,
"invoiceBatchId": "123e4567-e89b-12d3-a456-426614174000",
"invoiceType": "Invoice",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"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": "Customer",
"invoiceDeliveryMethod": "Email",
"name": "text",
"organizationNumber": "text",
"accountsReceivable": "text",
"currencyCode": "text",
"taxRegistrationNumber": "text",
"taxTemplate": "text",
"invoiceBatchGroupId": "123e4567-e89b-12d3-a456-426614174000",
"invoiceSettingGroupId": "123e4567-e89b-12d3-a456-426614174000",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"externalERPId": "text",
"externalCRMId": "text"
},
"journalId": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text",
"created": "2025-06-23T09:15:58.654Z",
"modified": "2025-06-23T09:15:58.654Z"
}
]
}
Code or Id
Filter the results. See ODATA documentation for more information
name eq 'Adam' and age gt 20
Sorting the results. See ODATA specification for more information
accountNumber Desc
Apply a separate modified After filter. See 'ModifiedBefore' filter for further details.
03/01/2025 00:00:00
Filter is applied on sub entities: transactions and transaction custom fields
03/01/2025 00:00:00
Page Size
20
Page Number
1
GET /Journals/AccountingTransactions/{year}/FinancialAccounts/{financialAccount} HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"pageNumber": 1,
"pageSize": 1,
"totalPages": 1,
"totalCount": 1,
"nextPage": "https://example.com",
"previousPage": "https://example.com",
"firstPage": "https://example.com",
"lastPage": "https://example.com",
"data": [
{
"transactionNumber": "text",
"effectiveDate": "2025-06-23T09:15:58.654Z",
"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",
"invoice": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"invoiceNumber": "text",
"status": "Draft",
"notes": "text",
"invoiceDate": "2025-06-23T09:15:58.654Z",
"currency": "text",
"subtotal": 1,
"tax": 1,
"totalAmount": 1,
"settledAmount": 1,
"taxIncluded": true,
"invoiceBatchId": "123e4567-e89b-12d3-a456-426614174000",
"invoiceType": "Invoice",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"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": "Customer",
"invoiceDeliveryMethod": "Email",
"name": "text",
"organizationNumber": "text",
"accountsReceivable": "text",
"currencyCode": "text",
"taxRegistrationNumber": "text",
"taxTemplate": "text",
"invoiceBatchGroupId": "123e4567-e89b-12d3-a456-426614174000",
"invoiceSettingGroupId": "123e4567-e89b-12d3-a456-426614174000",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"externalERPId": "text",
"externalCRMId": "text"
},
"journalId": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text",
"created": "2025-06-23T09:15:58.654Z",
"modified": "2025-06-23T09:15:58.654Z"
}
]
}
Filter the results. See ODATA documentation for more information
name eq 'Adam' and age gt 20
Sorting the results. See ODATA specification for more information
accountNumber Desc
Apply a separate modified After filter. See 'ModifiedBefore' filter for further details.
03/01/2025 00:00:00
Filter is applied on sub entities: transactions and transaction custom fields
03/01/2025 00:00:00
Page Size
20
Page Number
1
GET /Journals/{id}/AccountingTransactions HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"pageNumber": 1,
"pageSize": 1,
"totalPages": 1,
"totalCount": 1,
"nextPage": "https://example.com",
"previousPage": "https://example.com",
"firstPage": "https://example.com",
"lastPage": "https://example.com",
"data": [
{
"transactionNumber": "text",
"effectiveDate": "2025-06-23T09:15:58.654Z",
"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",
"invoice": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"invoiceNumber": "text",
"status": "Draft",
"notes": "text",
"invoiceDate": "2025-06-23T09:15:58.654Z",
"currency": "text",
"subtotal": 1,
"tax": 1,
"totalAmount": 1,
"settledAmount": 1,
"taxIncluded": true,
"invoiceBatchId": "123e4567-e89b-12d3-a456-426614174000",
"invoiceType": "Invoice",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"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": "Customer",
"invoiceDeliveryMethod": "Email",
"name": "text",
"organizationNumber": "text",
"accountsReceivable": "text",
"currencyCode": "text",
"taxRegistrationNumber": "text",
"taxTemplate": "text",
"invoiceBatchGroupId": "123e4567-e89b-12d3-a456-426614174000",
"invoiceSettingGroupId": "123e4567-e89b-12d3-a456-426614174000",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"externalERPId": "text",
"externalCRMId": "text"
},
"journalId": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text",
"created": "2025-06-23T09:15:58.654Z",
"modified": "2025-06-23T09:15:58.654Z"
}
]
}
Last updated
Was this helpful?