Back to endpoints

Get Journal Entries

GET api/V3/{language}/org/{orgIdentifier}/JournalEntries

?from={from}

&to={to}

&page={page}

&perPage={perPage}

Returns a list of all journal entries sorted by most recent first. It is possible to specify a date range or only start (from) or end (to) date. If no dates are specified, all the journal entries for the organization are returned.

Request Information

URI Parameters

PARAMETERS
language (string)

Language in which the localizable values should be returned. Part of base url. Value is either 'fr' or 'en'

Required
orgIdentifier (string)

Amilia-specific organization identifier. This identifier can be either the organization number, such as 8008, or the organization URL identifier. You can find that by looking at the URL of your Amilia store. It may look like lower-case words separated by a dash, such as forest-explorers. Note that in v2 and v1 we call that the 'rewrite URL'.

Required
from (date)

Start date formatted as YYYY-MM-DD. Inclusive in all versions of the API. Default value is null

Optional
to (date)

End date formatted as YYYY-MM-DD. Inclusive in version 3, exclusive in previous versions of the API. Default value is null

Optional
page (integer)

Result page number that appears first.

Default value is 1

Optional
perPage (integer)

Number of results per page.

Default value is 200

Optional

Body Parameters

None.

Response Information

Resource Description

PARAMETERS
Id (integer)

Resource id

EffectiveDate (date)

Date when resource is effective. Format is 9999-12-31

LedgerEntry (LedgerCodeBaseApiModelV3)
Amount (decimal number)
PostingType (DebitCredit)
InvoiceItem (GenericApiIdObjectV3)
Invoice (GenericApiIdObjectV3)
Payment (GenericApiIdObjectV3)
Account (GenericApiIdObjectV3)
IsCorrection (boolean)
GroupType (GroupType)
Details ()

Response Formats

CODE SAMPLE JSON
[
  {
    "Id": 1,
    "EffectiveDate": "2022-08-13T10:29:58.6235514-04:00",
    "LedgerEntry": {
      "Id": 1,
      "Code": "string 2",
      "Title": "string 3"
    },
    "Amount": 3.0,
    "PostingType": "Debit",
    "InvoiceItem": {
      "Id": 1
    },
    "Invoice": {
      "Id": 1
    },
    "Payment": {
      "Id": 1
    },
    "Account": {
      "Id": 1
    },
    "IsCorrection": true,
    "GroupType": "Invoice",
    "Details": [
      {
        "Id": 1,
        "Amount": 2.0,
        "PostingType": "Debit",
        "RevenueLedger": {
          "Id": 1,
          "Code": "string 2",
          "Title": "string 3"
        },
        "DeferredRevenueLedger": {
          "Id": 1,
          "Code": "string 2",
          "Title": "string 3"
        },
        "ContraRevenueLedger": {
          "Id": 1,
          "Code": "string 2",
          "Title": "string 3"
        },
        "DeferredContraRevenueLedger": {
          "Id": 1,
          "Code": "string 2",
          "Title": "string 3"
        },
        "LiabilityLedger": {
          "Id": 1,
          "Code": "string 2",
          "Title": "string 3"
        },
        "InvoiceItem": {
          "Id": 1
        }
      },
      {
        "Id": 1,
        "Amount": 2.0,
        "PostingType": "Debit",
        "RevenueLedger": {
          "Id": 1,
          "Code": "string 2",
          "Title": "string 3"
        },
        "DeferredRevenueLedger": {
          "Id": 1,
          "Code": "string 2",
          "Title": "string 3"
        },
        "ContraRevenueLedger": {
          "Id": 1,
          "Code": "string 2",
          "Title": "string 3"
        },
        "DeferredContraRevenueLedger": {
          "Id": 1,
          "Code": "string 2",
          "Title": "string 3"
        },
        "LiabilityLedger": {
          "Id": 1,
          "Code": "string 2",
          "Title": "string 3"
        },
        "InvoiceItem": {
          "Id": 1
        }
      }
    ]
  },
  {
    "Id": 1,
    "EffectiveDate": "2022-08-13T10:29:58.6235514-04:00",
    "LedgerEntry": {
      "Id": 1,
      "Code": "string 2",
      "Title": "string 3"
    },
    "Amount": 3.0,
    "PostingType": "Debit",
    "InvoiceItem": {
      "Id": 1
    },
    "Invoice": {
      "Id": 1
    },
    "Payment": {
      "Id": 1
    },
    "Account": {
      "Id": 1
    },
    "IsCorrection": true,
    "GroupType": "Invoice",
    "Details": [
      {
        "Id": 1,
        "Amount": 2.0,
        "PostingType": "Debit",
        "RevenueLedger": {
          "Id": 1,
          "Code": "string 2",
          "Title": "string 3"
        },
        "DeferredRevenueLedger": {
          "Id": 1,
          "Code": "string 2",
          "Title": "string 3"
        },
        "ContraRevenueLedger": {
          "Id": 1,
          "Code": "string 2",
          "Title": "string 3"
        },
        "DeferredContraRevenueLedger": {
          "Id": 1,
          "Code": "string 2",
          "Title": "string 3"
        },
        "LiabilityLedger": {
          "Id": 1,
          "Code": "string 2",
          "Title": "string 3"
        },
        "InvoiceItem": {
          "Id": 1
        }
      },
      {
        "Id": 1,
        "Amount": 2.0,
        "PostingType": "Debit",
        "RevenueLedger": {
          "Id": 1,
          "Code": "string 2",
          "Title": "string 3"
        },
        "DeferredRevenueLedger": {
          "Id": 1,
          "Code": "string 2",
          "Title": "string 3"
        },
        "ContraRevenueLedger": {
          "Id": 1,
          "Code": "string 2",
          "Title": "string 3"
        },
        "DeferredContraRevenueLedger": {
          "Id": 1,
          "Code": "string 2",
          "Title": "string 3"
        },
        "LiabilityLedger": {
          "Id": 1,
          "Code": "string 2",
          "Title": "string 3"
        },
        "InvoiceItem": {
          "Id": 1
        }
      }
    ]
  }
]