latestOpenAPI 3.0.02026-08-10233809957.8 KB

5cdfae3fa1fa

Accounting Transactions

Gets an accounting transaction summary report for a business.

get/accountingTransactions

Query parameters

businessNamestring required

Unique business name identifier.

serviceName'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'myob' | 'zohoBooks' required

Name of accounting service provider.

startDatestring

Date from which the report data begins in the format: YYYY-MM-DD.

endDatestring

Date from which the report data ends in the format: YYYY-MM-DD.

offsetnumber

The offset is the position in the dataset of a particular record.

limitnumber

This is the size of the results set you would like (default: 100).

orderBystring

Response

countnumber required

Example response

{
  "meta": {
    "reportId": [
      "5fad8a342a88364234392fb5",
      "5fad8a342a88364234392fb6"
    ],
    "serviceName": "xero",
    "businessName": "Railz",
    "startDate": "2020-11-25T01:02:03Z",
    "endDate": "2020-11-30T01:02:03Z",
    "createdAt": "2020-11-25T01:02:03Z",
    "updatedAt": "2020-11-30T01:02:03Z"
  },
  "data": [
    {
      "postedDate": "2020-11-25",
      "type": "invoice",
      "isReconciled": true,
      "currencyRate": 1.13,
      "isSplitTransaction": true,
      "subTotal": 300.5,
      "taxAmount": 10.5,
      "totalAmount": 311,
      "memo": "Transaction reference",
      "sourceModifiedDate": "2021-03-09T10:18:29.985Z",
      "id": "1045",
      "isPosting": true,
      "transactionNumber": "INV-001",
      "entityRef": {
        "id": "233",
        "name": "Railz Inc."
      },
      "trackingCategoryRef": {
        "id": "4040",
        "name": "Region",
        "option": "East",
        "optionId": "40401"
      },
      "accountRef": {
        "id": "1334",
        "name": "Account Receivable",
        "section": "Assets",
        "subSection": "Current Assets",
        "group": "Cash And Cash Equivalents",
        "subGroup": "Cash And Cash Equivalents"
      },
      "currencyRef": {
        "id": "CAD",
        "name": "Canadian Dollar",
        "symbol": "\tUSD,CAD"
      }
    }
  ],
  "count": 1
}