Sign in
latestOpenAPI 3.0.02026-08-10233809957.8 KB

5cdfae3fa1fa

Inventory

List Inventory Items

Supported for:

freshbooks quickbooks quickbooksDesktop xero oracleNetsuite sageBusinessCloud sageIntacct dynamicsBusinessCentral dynamics365Finance wave myob zohoBooks

get/v2/accounting/inventory

Query parameters

connectionUuidstring required

Unique connection identifier.

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

Example response

{
  "meta": {
    "connectionUuid": "CON-396d5daa-26b2-4979-89b6-cafb2c298155",
    "businessName": "Railz",
    "serviceName": "xero",
    "reportId": [
      "5fad8a342a88364234392fb5",
      "5fad8a342a88364234392fb6"
    ],
    "createdAt": "2020-11-25T01:02:03Z",
    "updatedAt": "2020-11-30T01:02:03Z"
  },
  "data": [
    {
      "id": "1",
      "name": "Product Services",
      "code": "100",
      "sourceModifiedDate": "2021-03-09T10:18:29.985Z",
      "billItem": {
        "description": "Item description",
        "unitPrice": 100.5,
        "accountRef": {
          "id": "145",
          "name": "Example account"
        },
        "taxRateRef": {
          "id": "1",
          "name": "HST",
          "effectiveTaxRate": 13
        }
      },
      "invoiceItem": {
        "description": "Item description",
        "unitPrice": 100.5,
        "accountRef": {
          "id": "145",
          "name": "Example account"
        },
        "taxRateRef": {
          "id": "1",
          "name": "HST",
          "effectiveTaxRate": 13
        }
      },
      "isInvoiceItem": true,
      "isBillItem": true,
      "subsidiaryRefs": [
        {
          "id": "2",
          "name": "Company Ltd"
        }
      ],
      "quantityOnHand": [
        {
          "locationRef": {
            "id": "9",
            "name": "Boston"
          },
          "quantity": 2.5,
          "accountRef": {
            "id": "145",
            "name": "Example account"
          }
        }
      ],
      "type": "inventory",
      "status": "active"
    }
  ]
}