Journal Entries

The JournalEntry object is used to represent a company's journey entries.

The JournalEntry object

Properties

idString
Required
remote_idString
Optional
The third-party API ID of the matching object.
remote_dataRemoteData[]
Optional
transaction_dateString
Optional
The journal entry's transaction date.
remote_created_atString
Optional
When the third party's journal entry was created.
paymentsArray
Required
Array of Payment object IDs.
memoString
Optional
The journal entry's private note.
currencyEnum
Optional
The journal's currency. Possible values include: XUA, AFN, AFA, ALL, ALK, DZD, ADP, AOA, AOK, AON, AOR, ARA, ARS, ARM, ARP, ARL, AMD, AWG, AUD, ATS, AZN, AZM, BSD, BHD, BDT, BBD, BYN, BYB, BYR, BEF, BEC, BEL, BZD, BMD, BTN, BOB, BOL, BOV, BOP, BAM, BAD, BAN, BWP, BRC, BRZ, BRE, BRR, BRN, BRB, BRL, GBP, BND, BGL, BGN, BGO, BGM, BUK, BIF, XPF, KHR, CAD, CVE, KYD, XAF, CLE, CLP, CLF, CNX, CNY, CNH, COP, COU, KMF, CDF, CRC, HRD, HRK, CUC, CUP, CYP, CZK, CSK, DKK, DJF, DOP, NLG, XCD, DDM, ECS, ECV, EGP, GQE, ERN, EEK, ETB, EUR, XBA, XEU, XBB, XBC, XBD, FKP, FJD, FIM, FRF, XFO, XFU, GMD, GEK, GEL, DEM, GHS, GHC, GIP, XAU, GRD, GTQ, GWP, GNF, GNS, GYD, HTG, HNL, HKD, HUF, IMP, ISK, ISJ, INR, IDR, IRR, IQD, IEP, ILS, ILP, ILR, ITL, JMD, JPY, JOD, KZT, KES, KWD, KGS, LAK, LVL, LVR, LBP, LSL, LRD, LYD, LTL, LTT, LUL, LUC, LUF, MOP, MKD, MKN, MGA, MGF, MWK, MYR, MVR, MVP, MLF, MTL, MTP, MRU, MRO, MUR, MXV, MXN, MXP, MDC, MDL, MCF, MNT, MAD, MAF, MZE, MZN, MZM, MMK, NAD, NPR, ANG, TWD, NZD, NIO, NIC, NGN, KPW, NOK, OMR, PKR, XPD, PAB, PGK, PYG, PEI, PEN, PES, PHP, XPT, PLN, PLZ, PTE, GWE, QAR, XRE, RHD, RON, ROL, RUB, RUR, RWF, SVC, WST, SAR, RSD, CSD, SCR, SLL, XAG, SGD, SKK, SIT, SBD, SOS, ZAR, ZAL, KRH, KRW, KRO, SSP, SUR, ESP, ESA, ESB, XDR, LKR, SHP, XSU, SDD, SDG, SDP, SRD, SRG, SZL, SEK, CHF, SYP, STN, STD, TVD, TJR, TJS, TZS, XTS, THB, XXX, TPE, TOP, TTD, TND, TRY, TRL, TMT, TMM, USD, USN, USS, UGX, UGS, UAH, UAK, AED, UYW, UYU, UYP, UYI, UZS, VUV, VES, VEB, VEF, VND, VNN, CHE, CHW, XOF, YDD, YER, YUN, YUD, YUM, YUR, ZWN, ZRN, ZRZ, ZMW, ZMK, ZWD, ZWR, ZWL, or - in cases where there is no clear mapping - the original value passed through.
linesJournalLine[]
Required

The JournalLine object

The JournalLine object is used to represent a journal entry's line items.
JSON
{
  "remote_id": "121222",
  "account": "9d892439-5fab-4dbb-8bd8-34f7f96c7912",
  "net_amount": 25.54,
  "tracking_category": "d25d609b-945f-4762-b55a-1c8fb220c43c",
  "contact": "d2d5ea3c-b032-11ec-b909-0242ac120002",
  "description": "Cash payment for lunch"
}

Properties

remote_idString
Optional
The third-party API ID of the matching object.
accountString
Optional
net_amountNumber
Optional
The line's net amount.
tracking_categoryString
Optional
contactString
Optional
descriptionString
Optional
The line's description.
remote_was_deletedBoolean
Required
The JournalEntry object
JSON
{
  "id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4",
  "remote_id": "088899",
  "remote_data": [
    {
      "path": "/actions",
      "data": [
        "Varies by platform"
      ]
    }
  ],
  "transaction_date": "2020-03-31T00:00:00Z",
  "remote_created_at": "2020-03-31T00:00:00Z",
  "payments": [
    "b26fd49a-cbae-470a-a8f8-bcbc119e0390"
  ],
  "memo": "Weekly Payment",
  "currency": "USD",
  "lines": [
    {
      "remote_id": "121222",
      "contact": "d2d5ea3c-b032-11ec-b909-0242ac120002",
      "account": "9d892439-5fab-4dbb-8bd8-34f7f96c7912",
      "net_amount": 25.54,
      "description": "Cash payment for lunch"
    },
    {
      "remote_id": "121223",
      "account": "f963f34d-3d2f-4f77-b557-cf36bc7e6498",
      "net_amount": 10
    }
  ],
  "remote_was_deleted": true
}
GET

/journal-entries

Returns a list of JournalEntry objects.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters

created_afterString
Optional
If provided, will only return objects created after this datetime.
created_beforeString
Optional
If provided, will only return objects created before this datetime.
cursorString
Optional
The pagination cursor value.
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_afterString
Optional
If provided, will only return objects modified after this datetime.
modified_beforeString
Optional
If provided, will only return objects modified before this datetime.
page_sizeInteger
Optional
Number of results to return per page.
remote_idString
Optional
The API provider's ID for the given object.
Response
JSON
{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4",
      "remote_id": "088899",
      "remote_data": [
        {
          "path": "/actions",
          "data": [
            "Varies by platform"
          ]
        }
      ],
      "transaction_date": "2020-03-31T00:00:00Z",
      "remote_created_at": "2020-03-31T00:00:00Z",
      "payments": [
        "b26fd49a-cbae-470a-a8f8-bcbc119e0390"
      ],
      "memo": "Weekly Payment",
      "currency": "USD",
      "lines": [
        {
          "remote_id": "121222",
          "contact": "d2d5ea3c-b032-11ec-b909-0242ac120002",
          "account": "9d892439-5fab-4dbb-8bd8-34f7f96c7912",
          "net_amount": 25.54,
          "description": "Cash payment for lunch"
        },
        {
          "remote_id": "121223",
          "account": "f963f34d-3d2f-4f77-b557-cf36bc7e6498",
          "net_amount": 10
        }
      ],
      "remote_was_deleted": true
    }
  ]
}
Field support by platform

FreshBooks

FreshBooks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

remote_created_atString
remote_dataRemoteData[]
remote_idString

NetSuite

NetSuite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

currencyEnum
memoString
remote_created_atString
remote_dataRemoteData[]
remote_idString
transaction_dateString

QuickBooks Online

QuickBooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

currencyEnum
memoString
remote_created_atString
remote_dataRemoteData[]
remote_idString
transaction_dateString

Sage Business Cloud Accounting

Sage Business Cloud Accounting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

remote_created_atString
remote_dataRemoteData[]
remote_idString
transaction_dateString

Xero

Xero

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

memoString
remote_created_atString
remote_dataRemoteData[]
remote_idString
transaction_dateString

Zoho Books

Zoho Books

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

remote_idString
transaction_dateString
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
POST

/journal-entries

Creates a JournalEntry object with the given values.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters

is_debug_modeBoolean
Optional
Whether to include debug fields (such as log file links) in the response.
run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.

Body Parameters

modelObject
Required
Find available fields below under “Model Parameters”.

Model Parameters

remote_idString
Optional
The third-party API ID of the matching object.
transaction_dateString
Optional
The journal entry's transaction date.
remote_created_atString
Optional
When the third party's journal entry was created.
paymentsArray
Required
Array of Payment object IDs.
memoString
Optional
The journal entry's private note.
currencyEnum
Optional
The journal's currency. Must pass in one of the following choices: XUA, AFN, AFA, ALL, ALK, DZD, ADP, AOA, AOK, AON, AOR, ARA, ARS, ARM, ARP, ARL, AMD, AWG, AUD, ATS, AZN, AZM, BSD, BHD, BDT, BBD, BYN, BYB, BYR, BEF, BEC, BEL, BZD, BMD, BTN, BOB, BOL, BOV, BOP, BAM, BAD, BAN, BWP, BRC, BRZ, BRE, BRR, BRN, BRB, BRL, GBP, BND, BGL, BGN, BGO, BGM, BUK, BIF, XPF, KHR, CAD, CVE, KYD, XAF, CLE, CLP, CLF, CNX, CNY, CNH, COP, COU, KMF, CDF, CRC, HRD, HRK, CUC, CUP, CYP, CZK, CSK, DKK, DJF, DOP, NLG, XCD, DDM, ECS, ECV, EGP, GQE, ERN, EEK, ETB, EUR, XBA, XEU, XBB, XBC, XBD, FKP, FJD, FIM, FRF, XFO, XFU, GMD, GEK, GEL, DEM, GHS, GHC, GIP, XAU, GRD, GTQ, GWP, GNF, GNS, GYD, HTG, HNL, HKD, HUF, IMP, ISK, ISJ, INR, IDR, IRR, IQD, IEP, ILS, ILP, ILR, ITL, JMD, JPY, JOD, KZT, KES, KWD, KGS, LAK, LVL, LVR, LBP, LSL, LRD, LYD, LTL, LTT, LUL, LUC, LUF, MOP, MKD, MKN, MGA, MGF, MWK, MYR, MVR, MVP, MLF, MTL, MTP, MRU, MRO, MUR, MXV, MXN, MXP, MDC, MDL, MCF, MNT, MAD, MAF, MZE, MZN, MZM, MMK, NAD, NPR, ANG, TWD, NZD, NIO, NIC, NGN, KPW, NOK, OMR, PKR, XPD, PAB, PGK, PYG, PEI, PEN, PES, PHP, XPT, PLN, PLZ, PTE, GWE, QAR, XRE, RHD, RON, ROL, RUB, RUR, RWF, SVC, WST, SAR, RSD, CSD, SCR, SLL, XAG, SGD, SKK, SIT, SBD, SOS, ZAR, ZAL, KRH, KRW, KRO, SSP, SUR, ESP, ESA, ESB, XDR, LKR, SHP, XSU, SDD, SDG, SDP, SRD, SRG, SZL, SEK, CHF, SYP, STN, STD, TVD, TJR, TJS, TZS, XTS, THB, XXX, TPE, TOP, TTD, TND, TRY, TRL, TMT, TMM, USD, USN, USS, UGX, UGS, UAH, UAK, AED, UYW, UYU, UYP, UYI, UZS, VUV, VES, VEB, VEF, VND, VNN, CHE, CHW, XOF, YDD, YER, YUN, YUD, YUM, YUR, ZWN, ZRN, ZRZ, ZMW, ZMK, ZWD, ZWR, ZWL.
Response
JSON
{
  "model": {
    "id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4",
    "remote_id": "088899",
    "remote_data": [
      {
        "path": "/actions",
        "data": [
          "Varies by platform"
        ]
      }
    ],
    "transaction_date": "2020-03-31T00:00:00Z",
    "remote_created_at": "2020-03-31T00:00:00Z",
    "payments": [
      "b26fd49a-cbae-470a-a8f8-bcbc119e0390"
    ],
    "memo": "Weekly Payment",
    "currency": "USD",
    "lines": [
      {
        "remote_id": "121222",
        "contact": "d2d5ea3c-b032-11ec-b909-0242ac120002",
        "account": "9d892439-5fab-4dbb-8bd8-34f7f96c7912",
        "net_amount": 25.54,
        "description": "Cash payment for lunch"
      },
      {
        "remote_id": "121223",
        "account": "f963f34d-3d2f-4f77-b557-cf36bc7e6498",
        "net_amount": 10
      }
    ],
    "remote_was_deleted": true
  },
  "warnings": [
    {
      "source": {
        "pointer": "/age"
      },
      "title": "Unrecognized Field",
      "detail": "An unrecognized field, age, was passed in with request data.",
      "problem_type": "UNRECOGNIZED_FIELD"
    }
  ],
  "errors": [
    {
      "source": {
        "pointer": "/model/custom_fields"
      },
      "title": "Missing Required Field",
      "detail": "custom_fields is a required field on model.",
      "problem_type": "MISSING_REQUIRED_FIELD"
    }
  ],
  "logs": [
    {
      "log_id": "99433219-8017-4acd-bb3c-ceb23d663832",
      "dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832",
      "log_summary": {
        "url": "https://harvest.greenhouse.io/v1/candidates/",
        "method": "POST",
        "status_code": 200
      }
    }
  ]
}
Field support by platform

QuickBooks Online

QuickBooks Online

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters

remote_created_atString
Optional
remote_idString
Optional
transaction_dateString
Optional

Additional POST Parameters

linesObject
Required
net_amountString
Required

Xero

Xero

Merge supports Passthrough Requests to this platform's API

Supported POST Body Parameters

remote_idString
Optional
transaction_dateString
Optional
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/journal-entries/{id}

Returns a JournalEntry object with the given id.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idString
Required
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{
  "id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4",
  "remote_id": "088899",
  "remote_data": [
    {
      "path": "/actions",
      "data": [
        "Varies by platform"
      ]
    }
  ],
  "transaction_date": "2020-03-31T00:00:00Z",
  "remote_created_at": "2020-03-31T00:00:00Z",
  "payments": [
    "b26fd49a-cbae-470a-a8f8-bcbc119e0390"
  ],
  "memo": "Weekly Payment",
  "currency": "USD",
  "lines": [
    {
      "remote_id": "121222",
      "contact": "d2d5ea3c-b032-11ec-b909-0242ac120002",
      "account": "9d892439-5fab-4dbb-8bd8-34f7f96c7912",
      "net_amount": 25.54,
      "description": "Cash payment for lunch"
    },
    {
      "remote_id": "121223",
      "account": "f963f34d-3d2f-4f77-b557-cf36bc7e6498",
      "net_amount": 10
    }
  ],
  "remote_was_deleted": true
}
Field support by platform

FreshBooks

FreshBooks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

remote_created_atString
remote_dataRemoteData[]
remote_idString

NetSuite

NetSuite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

currencyEnum
memoString
remote_created_atString
remote_dataRemoteData[]
remote_idString
transaction_dateString

QuickBooks Online

QuickBooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

currencyEnum
memoString
remote_created_atString
remote_dataRemoteData[]
remote_idString
transaction_dateString

Sage Business Cloud Accounting

Sage Business Cloud Accounting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

remote_created_atString
remote_dataRemoteData[]
remote_idString
transaction_dateString

Xero

Xero

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

memoString
remote_created_atString
remote_dataRemoteData[]
remote_idString
transaction_dateString

Zoho Books

Zoho Books

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

remote_idString
transaction_dateString
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/journal-entries/meta/post

Returns metadata for JournalEntry POSTs.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.
Response
JSON
{
  "request_schema": {},
  "status": {
    "linked_account_status": "string",
    "can_make_request": true
  },
  "has_conditional_params": true,
  "has_required_linked_account_params": true
}
Field support by platform

FreshBooks

FreshBooks

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

remote_created_atString
remote_dataRemoteData[]
remote_idString

NetSuite

NetSuite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

currencyEnum
memoString
remote_created_atString
remote_dataRemoteData[]
remote_idString
transaction_dateString

QuickBooks Online

QuickBooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

currencyEnum
memoString
remote_created_atString
remote_dataRemoteData[]
remote_idString
transaction_dateString

Sage Business Cloud Accounting

Sage Business Cloud Accounting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

remote_created_atString
remote_dataRemoteData[]
remote_idString
transaction_dateString

Xero

Xero

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

memoString
remote_created_atString
remote_dataRemoteData[]
remote_idString
transaction_dateString

Zoho Books

Zoho Books

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

remote_idString
transaction_dateString
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.

Previous

Items

Next Up

Payments