API Reference
Signup For Free

Purchase Order Data Models

Purchase Order is request of goods or services from vendor. It has details about item, quantity and amount etc.

Model IDEvent KeyDescription
accounting_purchaseOrder_infoinfo
accounting_purchaseOrder_lineItemslineItems

📘

Manual Trigger Required for Initial Sync

The data models sync does not start automatically. To initiate the synchronization process, you must explicitly call the Sync Start API for the initial sync.

Purchase Order Info

Model ID: accounting_purchaseOrder_info

FieldTypeDescription
idString
purchaseOrderNumberString
statusEnum[DRAFT, SUBMITTED, AUTHORISED, BILLED, DELETED, OPENED, NOT_SPECIFIED]
createdAtDate
updatedAtDate
issueDateDate
deliveryDateDate
totalAmountDouble
totalTaxDouble
totalDiscountDouble
customerContactIdString
vendorContactIdString
companyIdString
descriptionString
currencyStringCurrency codes like USD, INR
exchangeRateString
addressesList[Address]Please refer to Address Model

Purchase Order entries

Model ID: accounting_purchaseOrder_lineItems

FieldTypeDescription
lineItemslist[PurchaseOrderLineItem]

PurchaseOrderLineItem

FieldTypeDescription
lineItemIdString
itemIdString
itemCodeString
itemNameString
descriptionString
taxRateIdString
accountIdString
taxAmountDouble
totalAmountDouble
quantityDouble
unitRateDouble
discountAmountDouble
discountPercentageDouble
trackingCategoriesList[TrackingCategoryInfo]Please refer to TrackingCategory

Event Data Example

{
  "info": {
    "id": "ab148a49-e2da-48c0-a13b-6a1f894c573d",
    "purchaseOrderNumber": "PO-0001",
    "status": "AUTHORISED",
    "createdAt": "2024-05-20T00:00:00Z",
    "updatedAt": "2024-05-20T17:18:11Z",
    "issueDate": "2024-05-20T00:00:00Z",
    "deliveryDate": "2024-05-29T00:00:00Z",
    "totalAmount": 1800.0,
    "totalTax": 0.0,
    "totalDiscount": 200.0,
    "customerContactId": "ac19c8f9-ac19c8f9",
    "vendorContactId": "ac19c8f9-4db3",
    "companyId": "ac19c8f9-a901-4db3-bef1-5aaca2a7c15a",
    "description": "Black Tshirt for employees",
    "currency": "USD",
    "exchangeRate": "1.0",
    "addresses": [
      {
        "addressLine1": "72/1A Church Street",
        "addressLine2": "Texas USA",
        "city": "Texas",
        "state": "Atlanta",
        "country": "USA",
        "zipCode": "20203939",
        "addressType": "BILLING"
      }
    ]
  },
  "lineItems": [
    {
      "lineItemId": "68b2f2d1-b52f-40da-aa8b-5392d6ae2fe4",
      "itemId": null,
      "itemCode": "T02",
      "itemName": null,
      "description": "Tshirt of medium size and black color from Knit Pvt. Ltd.",
      "taxRateId": "NONE",
      "accountId": "7050",
      "taxAmount": 0.0,
      "totalAmount": 1800.0,
      "quantity": 20.0,
      "unitRate": 100.0,
      "discountAmount": null,
      "discountPercentage": 10,
      "trackingCategories": [
        {
          "categoryId": "2340d-cdwwr",
          "categoryName": "ASIA",
          "parentCategoryId": "a12302-2334",
          "parentCategoryName": "Region"
        }
      ]
    }
  ]
}