Journals

Journals endpoints for the Accounting API Unified API

10.53.0
Run In Postman
|Full reference

Journals are daybooks used to group accounting entries and configure posting rules.

The Journals model

idstring

A unique identifier for an object.

codestring or null

Code used to select this journal when posting entries. For Exact Online, pass this code as journal_symbol, not the journal id.

namestring or null

Name of the journal.

descriptionstring or null

Description of the journal.

typestring or null
Enum:generalsalespurchasesales_credit_note

Normalized journal classification.

allow_vatboolean or null

Whether the journal permits VAT on entries. Null or absent means unknown. Exact Online exposes this setting for general journals; it must not be treated as a universal VAT capability flag for other journal types.

Journals example
{}

List Journals

get
https://unify.apideck.com/accounting/journals

List the journals (daybooks) available for posting accounting entries, including their codes, types, and VAT settings.

Authorizations:

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstringnon-empty
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

x-apideck-company-idstring

The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

cursorstring or null

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger[ 1 .. 200 ]
Default:20

Number of results to return. Minimum 1, Maximum 200, Default 20

pass_throughobjectpass_through[example_downstream_property]=example_downstream_property

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Journals
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

AFAS Software
AFAS Software
Exact Online
Exact Online
Exact Online NL
Exact Online NL
Exact Online UK
Exact Online UK
Fortnox
Fortnox
Microsoft Dynamics 365 Business Central
Microsoft Dynamics 365 Business Central
Odoo
Odoo
Pennylane
Pennylane
Sage Intacct
Sage Intacct
SnelStart
SnelStart
Twinfield
Twinfield
Access Financials
Access Financials
Request
Acumatica
Acumatica
Request
Alegra
Alegra
Request
banqUP
banqUP
Request
Campfire
Campfire
Request
Clear Books
Clear Books
Request
DATEV Unternehmen Online
DATEV Unternehmen Online
Request
Digits
Digits
Request
Dualentry
Dualentry
Request
e-Boekhouden.nl
e-Boekhouden.nl
Request
FreeAgent
FreeAgent
Request
FreshBooks
FreshBooks
Request
Holded
Holded
Request
Intuit Bank Feeds
Intuit Bank Feeds
Request
Intuit Enterprise Suite
Intuit Enterprise Suite
Request
Kashflow
Kashflow
Request
Moneybird
Moneybird
Request
MRI Software
MRI Software
Request
MYOB
MYOB
Request
MYOB Acumatica
MYOB Acumatica
Request
NetSuite
NetSuite
Request
Procountor
Procountor
Request
QuickBooks
QuickBooks
Request
QuickBooks Desktop
QuickBooks Desktop
Request
Restaurant365
Restaurant365
Request
Rillet
Rillet
Request
Sage Business Cloud Accounting
Sage Business Cloud Accounting
Request
Sage Intacct REST
Sage Intacct REST
Request
SAP S/4HANA Cloud
SAP S/4HANA Cloud
Request
Spiris
Spiris
Request
Stripe
Stripe
Request
Visma eAccounting
Visma eAccounting
Request
Visma Netvisor
Visma Netvisor
Request
Wafeq
Wafeq
Request
Wave
Wave
Request
Workday
Workday
Request
Xero
Xero
Request
Yuki
Yuki
Request
Zoho Books
Zoho Books
Request

Request example

import { Apideck } from "@apideck/unify";

const apideck = new Apideck({
  consumerId: "test-consumer",
  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
  apiKey: process.env["APIDECK_API_KEY"] ?? "",
});

async function run() {
  const result = await apideck.accounting.journals.list({
    serviceId: "salesforce",
    companyId: "12345",
    passThrough: {
      "search": "San Francisco",
    },
    fields: "id,updated_at",
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "exact-online",
  "resource": "journals",
  "operation": "all",
  "data": [
    {
      "id": "12345",
      "code": "90",
      "name": "General journal",
      "description": "General journal",
      "type": "general",
      "allow_vat": true,
      "currency": "USD",
      "iban": "GB33BUKB20201555555555",
      "default_account": {
        "id": "123456",
        "type": "ledger_account",
        "code": "1100",
        "display_id": "123456",
        "account_number": "123465",
        "name": "Current assets",
        "downstream_id": "12345"
      },
      "blocked": false,
      "created_at": "2020-09-30T07:43:32.000Z",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "custom_mappings": {}
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    },
    "total_count": 1,
    "warnings": [
      {
        "type": "downstream_request_failed",
        "status_code": 429,
        "error": "string",
        "operation": "getManager",
        "message": "string"
      }
    ]
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  },
  "_raw": {}
}

Create Journal

post
https://unify.apideck.com/accounting/journals

Create Journal

Authorizations:

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstringnon-empty
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

x-apideck-company-idstring

The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
codestring or null

Code used to select this journal when posting entries. For Exact Online, pass this code as journal_symbol, not the journal id.

namestring or null

Name of the journal.

descriptionstring or null

Description of the journal.

typestring or null
Enum:generalsalespurchasesales_credit_note

Normalized journal classification.

allow_vatboolean or null

Whether the journal permits VAT on entries. Null or absent means unknown. Exact Online exposes this setting for general journals; it must not be treated as a universal VAT capability flag for other journal types.

currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

ibanstring or null

International Bank Account Number

default_accountobject or null

A flexible account reference that can represent a ledger account (GL account), a bank account, or an employee payable account, depending on the connector's requirements.

blockedboolean or null

Whether the journal is blocked for posting.

Responses

201Journals
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Exact Online
Exact Online
Exact Online NL
Exact Online NL
Exact Online UK
Exact Online UK
Odoo
Odoo
Pennylane
Pennylane
Access Financials
Access Financials
Request
Acumatica
Acumatica
Request
AFAS Software
AFAS Software
Request
Alegra
Alegra
Request
banqUP
banqUP
Request
Campfire
Campfire
Request
Clear Books
Clear Books
Request
DATEV Unternehmen Online
DATEV Unternehmen Online
Request
Digits
Digits
Request
Dualentry
Dualentry
Request
e-Boekhouden.nl
e-Boekhouden.nl
Request
Fortnox
Fortnox
Request
FreeAgent
FreeAgent
Request
FreshBooks
FreshBooks
Request
Holded
Holded
Request
Intuit Bank Feeds
Intuit Bank Feeds
Request
Intuit Enterprise Suite
Intuit Enterprise Suite
Request
Kashflow
Kashflow
Request
Microsoft Dynamics 365 Business Central
Microsoft Dynamics 365 Business Central
Request
Moneybird
Moneybird
Request
MRI Software
MRI Software
Request
MYOB
MYOB
Request
MYOB Acumatica
MYOB Acumatica
Request
NetSuite
NetSuite
Request
Procountor
Procountor
Request
QuickBooks
QuickBooks
Request
QuickBooks Desktop
QuickBooks Desktop
Request
Restaurant365
Restaurant365
Request
Rillet
Rillet
Request
Sage Business Cloud Accounting
Sage Business Cloud Accounting
Request
Sage Intacct
Sage Intacct
Request
Sage Intacct REST
Sage Intacct REST
Request
SAP S/4HANA Cloud
SAP S/4HANA Cloud
Request
SnelStart
SnelStart
Request
Spiris
Spiris
Request
Stripe
Stripe
Request
Twinfield
Twinfield
Request
Visma eAccounting
Visma eAccounting
Request
Visma Netvisor
Visma Netvisor
Request
Wafeq
Wafeq
Request
Wave
Wave
Request
Workday
Workday
Request
Xero
Xero
Request
Yuki
Yuki
Request
Zoho Books
Zoho Books
Request

Request example

{
  "code": "90",
  "name": "General journal",
  "description": "General journal",
  "type": "general",
  "allow_vat": true,
  "currency": "USD",
  "iban": "GB33BUKB20201555555555",
  "default_account": {
    "id": "123456",
    "type": "ledger_account",
    "code": "1100",
    "display_id": "123456",
    "account_number": "123465"
  },
  "blocked": false
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "exact-online",
  "resource": "journals",
  "operation": "add",
  "data": {
    "id": "12345"
  },
  "_raw": {}
}

Get Journal

get
https://unify.apideck.com/accounting/journals/{id}

Get Journal

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstringnon-empty
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

x-apideck-company-idstring

The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

fieldsstring or null

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: fields=name,email,addresses.city

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Responses

200Journals
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Odoo
Odoo
Access Financials
Access Financials
Request
Acumatica
Acumatica
Request
AFAS Software
AFAS Software
Request
Alegra
Alegra
Request
banqUP
banqUP
Request
Campfire
Campfire
Request
Clear Books
Clear Books
Request
DATEV Unternehmen Online
DATEV Unternehmen Online
Request
Digits
Digits
Request
Dualentry
Dualentry
Request
e-Boekhouden.nl
e-Boekhouden.nl
Request
Exact Online
Exact Online
Request
Exact Online NL
Exact Online NL
Request
Exact Online UK
Exact Online UK
Request
Fortnox
Fortnox
Request
FreeAgent
FreeAgent
Request
FreshBooks
FreshBooks
Request
Holded
Holded
Request
Intuit Bank Feeds
Intuit Bank Feeds
Request
Intuit Enterprise Suite
Intuit Enterprise Suite
Request
Kashflow
Kashflow
Request
Microsoft Dynamics 365 Business Central
Microsoft Dynamics 365 Business Central
Request
Moneybird
Moneybird
Request
MRI Software
MRI Software
Request
MYOB
MYOB
Request
MYOB Acumatica
MYOB Acumatica
Request
NetSuite
NetSuite
Request
Pennylane
Pennylane
Request
Procountor
Procountor
Request
QuickBooks
QuickBooks
Request
QuickBooks Desktop
QuickBooks Desktop
Request
Restaurant365
Restaurant365
Request
Rillet
Rillet
Request
Sage Business Cloud Accounting
Sage Business Cloud Accounting
Request
Sage Intacct
Sage Intacct
Request
Sage Intacct REST
Sage Intacct REST
Request
SAP S/4HANA Cloud
SAP S/4HANA Cloud
Request
SnelStart
SnelStart
Request
Spiris
Spiris
Request
Stripe
Stripe
Request
Twinfield
Twinfield
Request
Visma eAccounting
Visma eAccounting
Request
Visma Netvisor
Visma Netvisor
Request
Wafeq
Wafeq
Request
Wave
Wave
Request
Workday
Workday
Request
Xero
Xero
Request
Yuki
Yuki
Request
Zoho Books
Zoho Books
Request

Request example

import { Apideck } from "@apideck/unify";

const apideck = new Apideck({
  consumerId: "test-consumer",
  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
  apiKey: process.env["APIDECK_API_KEY"] ?? "",
});

async function run() {
  const result = await apideck.accounting.journals.get({
    id: "<id>",
    serviceId: "salesforce",
    companyId: "12345",
    fields: "id,updated_at",
  });

  console.log(result);
}

run();

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "exact-online",
  "resource": "journals",
  "operation": "one",
  "data": {
    "id": "12345",
    "code": "90",
    "name": "General journal",
    "description": "General journal",
    "type": "general",
    "allow_vat": true,
    "currency": "USD",
    "iban": "GB33BUKB20201555555555",
    "default_account": {
      "id": "123456",
      "type": "ledger_account",
      "code": "1100",
      "display_id": "123456",
      "account_number": "123465",
      "name": "Current assets",
      "downstream_id": "12345"
    },
    "blocked": false,
    "created_at": "2020-09-30T07:43:32.000Z",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "custom_mappings": {}
  },
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    },
    "total_count": 1,
    "warnings": [
      {
        "type": "downstream_request_failed",
        "status_code": 429,
        "error": "string",
        "operation": "getManager",
        "message": "string"
      }
    ]
  },
  "_raw": {}
}

Update Journal

patch
https://unify.apideck.com/accounting/journals/{id}

Update Journal

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstringnon-empty
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

x-apideck-company-idstring

The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
codestring or null

Code used to select this journal when posting entries. For Exact Online, pass this code as journal_symbol, not the journal id.

namestring or null

Name of the journal.

descriptionstring or null

Description of the journal.

typestring or null
Enum:generalsalespurchasesales_credit_note

Normalized journal classification.

allow_vatboolean or null

Whether the journal permits VAT on entries. Null or absent means unknown. Exact Online exposes this setting for general journals; it must not be treated as a universal VAT capability flag for other journal types.

currencystring or null
Enum:UNKNOWN_CURRENCYAEDAFNALL

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

ibanstring or null

International Bank Account Number

default_accountobject or null

A flexible account reference that can represent a ledger account (GL account), a bank account, or an employee payable account, depending on the connector's requirements.

blockedboolean or null

Whether the journal is blocked for posting.

Responses

200Journals
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Odoo
Odoo
Access Financials
Access Financials
Request
Acumatica
Acumatica
Request
AFAS Software
AFAS Software
Request
Alegra
Alegra
Request
banqUP
banqUP
Request
Campfire
Campfire
Request
Clear Books
Clear Books
Request
DATEV Unternehmen Online
DATEV Unternehmen Online
Request
Digits
Digits
Request
Dualentry
Dualentry
Request
e-Boekhouden.nl
e-Boekhouden.nl
Request
Exact Online
Exact Online
Request
Exact Online NL
Exact Online NL
Request
Exact Online UK
Exact Online UK
Request
Fortnox
Fortnox
Request
FreeAgent
FreeAgent
Request
FreshBooks
FreshBooks
Request
Holded
Holded
Request
Intuit Bank Feeds
Intuit Bank Feeds
Request
Intuit Enterprise Suite
Intuit Enterprise Suite
Request
Kashflow
Kashflow
Request
Microsoft Dynamics 365 Business Central
Microsoft Dynamics 365 Business Central
Request
Moneybird
Moneybird
Request
MRI Software
MRI Software
Request
MYOB
MYOB
Request
MYOB Acumatica
MYOB Acumatica
Request
NetSuite
NetSuite
Request
Pennylane
Pennylane
Request
Procountor
Procountor
Request
QuickBooks
QuickBooks
Request
QuickBooks Desktop
QuickBooks Desktop
Request
Restaurant365
Restaurant365
Request
Rillet
Rillet
Request
Sage Business Cloud Accounting
Sage Business Cloud Accounting
Request
Sage Intacct
Sage Intacct
Request
Sage Intacct REST
Sage Intacct REST
Request
SAP S/4HANA Cloud
SAP S/4HANA Cloud
Request
SnelStart
SnelStart
Request
Spiris
Spiris
Request
Stripe
Stripe
Request
Twinfield
Twinfield
Request
Visma eAccounting
Visma eAccounting
Request
Visma Netvisor
Visma Netvisor
Request
Wafeq
Wafeq
Request
Wave
Wave
Request
Workday
Workday
Request
Xero
Xero
Request
Yuki
Yuki
Request
Zoho Books
Zoho Books
Request

Request example

{
  "code": "90",
  "name": "General journal",
  "description": "General journal",
  "type": "general",
  "allow_vat": true,
  "currency": "USD",
  "iban": "GB33BUKB20201555555555",
  "default_account": {
    "id": "123456",
    "type": "ledger_account",
    "code": "1100",
    "display_id": "123456",
    "account_number": "123465"
  },
  "blocked": false
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "exact-online",
  "resource": "journals",
  "operation": "update",
  "data": {
    "id": "12345"
  },
  "_raw": {}
}

Delete Journal

delete
https://unify.apideck.com/accounting/journals/{id}

Delete Journal

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstringnon-empty
required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

x-apideck-company-idstring

The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.

Query parameters

rawboolean
Default:false

Include raw response. Mostly used for debugging purposes

Responses

200Journals
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Mapping coverage per connector

Odoo
Odoo
Access Financials
Access Financials
Request
Acumatica
Acumatica
Request
AFAS Software
AFAS Software
Request
Alegra
Alegra
Request
banqUP
banqUP
Request
Campfire
Campfire
Request
Clear Books
Clear Books
Request
DATEV Unternehmen Online
DATEV Unternehmen Online
Request
Digits
Digits
Request
Dualentry
Dualentry
Request
e-Boekhouden.nl
e-Boekhouden.nl
Request
Exact Online
Exact Online
Request
Exact Online NL
Exact Online NL
Request
Exact Online UK
Exact Online UK
Request
Fortnox
Fortnox
Request
FreeAgent
FreeAgent
Request
FreshBooks
FreshBooks
Request
Holded
Holded
Request
Intuit Bank Feeds
Intuit Bank Feeds
Request
Intuit Enterprise Suite
Intuit Enterprise Suite
Request
Kashflow
Kashflow
Request
Microsoft Dynamics 365 Business Central
Microsoft Dynamics 365 Business Central
Request
Moneybird
Moneybird
Request
MRI Software
MRI Software
Request
MYOB
MYOB
Request
MYOB Acumatica
MYOB Acumatica
Request
NetSuite
NetSuite
Request
Pennylane
Pennylane
Request
Procountor
Procountor
Request
QuickBooks
QuickBooks
Request
QuickBooks Desktop
QuickBooks Desktop
Request
Restaurant365
Restaurant365
Request
Rillet
Rillet
Request
Sage Business Cloud Accounting
Sage Business Cloud Accounting
Request
Sage Intacct
Sage Intacct
Request
Sage Intacct REST
Sage Intacct REST
Request
SAP S/4HANA Cloud
SAP S/4HANA Cloud
Request
SnelStart
SnelStart
Request
Spiris
Spiris
Request
Stripe
Stripe
Request
Twinfield
Twinfield
Request
Visma eAccounting
Visma eAccounting
Request
Visma Netvisor
Visma Netvisor
Request
Wafeq
Wafeq
Request
Wave
Wave
Request
Workday
Workday
Request
Xero
Xero
Request
Yuki
Yuki
Request
Zoho Books
Zoho Books
Request

Request example

import { Apideck } from "@apideck/unify";

const apideck = new Apideck({
  consumerId: "test-consumer",
  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
  apiKey: process.env["APIDECK_API_KEY"] ?? "",
});

async function run() {
  const result = await apideck.accounting.journals.delete({
    id: "<id>",
    serviceId: "salesforce",
    companyId: "12345",
  });

  console.log(result);
}

run();

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "exact-online",
  "resource": "journals",
  "operation": "delete",
  "data": {
    "id": "12345"
  },
  "_raw": {}
}