Sign in
latestOpenAPI 3.0.02026-08-10233809957.8 KB

5cdfae3fa1fa

Inventory

PUT an update to an individual inventory item for a business.

put/inventory/{id}

Path parameters

idstring required

Request body

Example request

{
  "connection": {
    "businessName": "Railz",
    "serviceName": "quickbooks"
  },
  "data": {
    "code": "GOL-W",
    "type": "inventory",
    "subsidiaryRefs": [
      "2",
      "3hn",
      "1t2"
    ],
    "name": "White golf balls.",
    "invoiceItem": {
      "description": "Item description.",
      "unitPrice": 2.5,
      "accountRef": "200",
      "taxRateRef": "12"
    },
    "billItem": {
      "description": "Item description.",
      "unitPrice": 2.5,
      "accountRef": "200",
      "taxRateRef": "12"
    },
    "isBillItem": true,
    "isInvoiceItem": true
  }
}

Response

pushCommunicationIdstring required
requestedOnstring date-time required
status'success' | 'failed' | 'pending' required
businessNamestring required
serviceName'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'wave' | 'myob' | 'zohoBooks' | 'byod' required

Example response

{
  "pushCommunicationId": "60473b57f0cdd1683ca71f60",
  "requestedOn": "2021-03-09T08:15:22.035Z",
  "status": "pending",
  "businessName": "Railz",
  "serviceName": "quickbooks",
  "data": {
    "code": "GOL-W",
    "type": "inventory",
    "subsidiaryRefs": [
      "2",
      "3hn",
      "1t2"
    ],
    "name": "White golf balls.",
    "invoiceItem": {
      "description": "Item description.",
      "unitPrice": 2.5,
      "accountRef": "200",
      "taxRateRef": "12"
    },
    "billItem": {
      "description": "Item description.",
      "unitPrice": 2.5,
      "accountRef": "200",
      "taxRateRef": "12"
    },
    "isBillItem": true,
    "isInvoiceItem": true
  }
}