Get Purchase Invoice Line For Purchase Invoice

Retrieve the properties and relationships of an object of type purchaseInvoiceLine for Dynamics 365 Business Central.

GET/companies({company_id})/purchaseInvoices({purchaseInvoice_id})/purchaseInvoiceLines('{purchaseInvoiceLine_id}')

Use it in a workflow

Add a step and choose the Microsoft Dynamics 365 Business Central connector.
Pick the Get Purchase Invoice Line For Purchase Invoice action (under Business Central).
Fill in the fields below, then reference the result from later steps as {{getPurchaseInvoiceLineForPurchaseInvoice.response.data}}.

Request

Path parameters

company_idstring (uuid)required

(v1.0) id for company

purchaseInvoice_idstring (uuid)required

(v1.0) id for purchaseInvoice

purchaseInvoiceLine_idstringrequired

(v1.0) id for purchaseInvoiceLine

Query parameters

$expandarray<string>

(v1.0) Entities to expand

$selectarray<string>

(v1.0) Selected properties to be retrieved

Response

Returns 200 with an object. Read it in later steps with {{getPurchaseInvoiceLineForPurchaseInvoice.response.data.<field>}}.

idstring

(v1.0) The id property for the Dynamics 365 Business Central purchaseInvoiceLine entity

documentIdstring (uuid)

(v1.0) The documentId property for the Dynamics 365 Business Central purchaseInvoiceLine entity

sequenceinteger (int32)

(v1.0) The sequence property for the Dynamics 365 Business Central purchaseInvoiceLine entity

itemIdstring (uuid)

(v1.0) The itemId property for the Dynamics 365 Business Central purchaseInvoiceLine entity

accountIdstring (uuid)

(v1.0) The accountId property for the Dynamics 365 Business Central purchaseInvoiceLine entity

lineTypestring

(v1.0) The lineType property for the Dynamics 365 Business Central purchaseInvoiceLine entity

lineDetailsobject

numberstring

(v1.0) The number property for the Dynamics 365 Business Central documentlineobjectdetailstype entity

displayNamestring

(v1.0) The displayName property for the Dynamics 365 Business Central documentlineobjectdetailstype entity

itemobject20 fields

accountobject

(schema truncated: exceeded maximum nesting depth)

descriptionstring

(v1.0) The description property for the Dynamics 365 Business Central purchaseInvoiceLine entity

unitOfMeasureobject

codestring

(v1.0) The code property for the Dynamics 365 Business Central unitofmeasuretype entity

displayNamestring

(v1.0) The displayName property for the Dynamics 365 Business Central unitofmeasuretype entity

symbolstring

(v1.0) The symbol property for the Dynamics 365 Business Central unitofmeasuretype entity

unitConversionobject5 fields

picturearray<object>6 fields

defaultDimensionsarray<object>9 fields

itemCategoryobject4 fields

unitCostnumber (decimal)

(v1.0) The unitCost property for the Dynamics 365 Business Central purchaseInvoiceLine entity

quantitynumber (decimal)

(v1.0) The quantity property for the Dynamics 365 Business Central purchaseInvoiceLine entity

discountAmountnumber (decimal)

(v1.0) The discountAmount property for the Dynamics 365 Business Central purchaseInvoiceLine entity

discountPercentnumber (decimal)

(v1.0) The discountPercent property for the Dynamics 365 Business Central purchaseInvoiceLine entity

discountAppliedBeforeTaxboolean

(v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central purchaseInvoiceLine entity

amountExcludingTaxnumber (decimal)

(v1.0) The amountExcludingTax property for the Dynamics 365 Business Central purchaseInvoiceLine entity

taxCodestring

(v1.0) The taxCode property for the Dynamics 365 Business Central purchaseInvoiceLine entity

taxPercentnumber (decimal)

(v1.0) The taxPercent property for the Dynamics 365 Business Central purchaseInvoiceLine entity

totalTaxAmountnumber (decimal)

(v1.0) The totalTaxAmount property for the Dynamics 365 Business Central purchaseInvoiceLine entity

amountIncludingTaxnumber (decimal)

(v1.0) The amountIncludingTax property for the Dynamics 365 Business Central purchaseInvoiceLine entity

invoiceDiscountAllocationnumber (decimal)

(v1.0) The invoiceDiscountAllocation property for the Dynamics 365 Business Central purchaseInvoiceLine entity

netAmountnumber (decimal)

(v1.0) The netAmount property for the Dynamics 365 Business Central purchaseInvoiceLine entity

netTaxAmountnumber (decimal)

(v1.0) The netTaxAmount property for the Dynamics 365 Business Central purchaseInvoiceLine entity

netAmountIncludingTaxnumber (decimal)

(v1.0) The netAmountIncludingTax property for the Dynamics 365 Business Central purchaseInvoiceLine entity

expectedReceiptDatestring (date-time)

(v1.0) The expectedReceiptDate property for the Dynamics 365 Business Central purchaseInvoiceLine entity

itemobject

idstring (uuid)

(v1.0) The id property for the Dynamics 365 Business Central item entity

numberstring

(v1.0) The number property for the Dynamics 365 Business Central item entity

displayNamestring

(v1.0) The displayName property for the Dynamics 365 Business Central item entity

typestring

(v1.0) The type property for the Dynamics 365 Business Central item entity

itemCategoryIdstring (uuid)

(v1.0) The itemCategoryId property for the Dynamics 365 Business Central item entity

itemCategoryCodestring

(v1.0) The itemCategoryCode property for the Dynamics 365 Business Central item entity

blockedboolean

(v1.0) The blocked property for the Dynamics 365 Business Central item entity

baseUnitOfMeasureIdstring (uuid)

(v1.0) The baseUnitOfMeasureId property for the Dynamics 365 Business Central item entity

baseUnitOfMeasureobject7 fields

gtinstring

(v1.0) The gtin property for the Dynamics 365 Business Central item entity

inventorynumber (decimal)

(v1.0) The inventory property for the Dynamics 365 Business Central item entity

unitPricenumber (decimal)

(v1.0) The unitPrice property for the Dynamics 365 Business Central item entity

priceIncludesTaxboolean

(v1.0) The priceIncludesTax property for the Dynamics 365 Business Central item entity

unitCostnumber (decimal)

(v1.0) The unitCost property for the Dynamics 365 Business Central item entity

taxGroupIdstring (uuid)

(v1.0) The taxGroupId property for the Dynamics 365 Business Central item entity

taxGroupCodestring

(v1.0) The taxGroupCode property for the Dynamics 365 Business Central item entity

lastModifiedDateTimestring (date-time)

(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central item entity

picturearray<object>6 fields

defaultDimensionsarray<object>9 fields

itemCategoryobject4 fields

accountobject

(schema truncated: exceeded maximum nesting depth)

json

{
  "id": "string",
  "documentId": "00000000-0000-0000-0000-000000000000",
  "sequence": 0,
  "itemId": "00000000-0000-0000-0000-000000000000",
  "accountId": "00000000-0000-0000-0000-000000000000",
  "lineType": "string",
  "lineDetails": {
    "number": "string",
    "displayName": "string",
    "item": {
      "id": "00000000-0000-0000-0000-000000000000",
      "number": "string",
      "displayName": "string",
      "type": "string",
      "itemCategoryId": "00000000-0000-0000-0000-000000000000",
      "itemCategoryCode": "string",
      "blocked": false,
      "baseUnitOfMeasureId": "00000000-0000-0000-0000-000000000000",
      "baseUnitOfMeasure": {
        "code": "string",
        "displayName": "string",
        "symbol": "string",
        "unitConversion": {
          "toUnitOfMeasure": "string",
          "fromToConversionRate": 0,
          "picture": [
            {
              "id": null,
              "width": null,
              "height": null,
              "contentType": null,
              "content@odata.mediaEditLink": null,
              "content@odata.mediaReadLink": null
            }
          ],
          "defaultDimensions": [
            {
              "parentId": null,
              "dimensionId": null,
              "dimensionCode": null,
              "dimensionValueId": null,
              "dimensionValueCode": null,
              "postingValidation": null,
              "account": null,
              "dimension": null,
              "dimensionValue": null
            }
          ],
          "itemCategory": {
            "id": "00000000-0000-0000-0000-000000000000",
            "code": "string",
            "displayName": "string",
            "lastModifiedDateTime": "2025-01-01T00:00:00Z"
          }
        },
        "picture": [
          {
            "id": "00000000-0000-0000-0000-000000000000",
            "width": 0,
            "height": 0,
            "contentType": "string",
            "content@odata.mediaEditLink": "string",
            "content@odata.mediaReadLink": "string"
          }
        ],
        "defaultDimensions": [
          {
            "parentId": "00000000-0000-0000-0000-000000000000",
            "dimensionId": "00000000-0000-0000-0000-000000000000",
            "dimensionCode": "string",
            "dimensionValueId": "00000000-0000-0000-0000-000000000000",
            "dimensionValueCode": "string",
            "postingValidation": "string",
            "account": {},
            "dimension": {},
            "dimensionValue": {}
          }
        ],
        "itemCategory": {
          "id": "00000000-0000-0000-0000-000000000000",
          "code": "string",
          "displayName": "string",
          "lastModifiedDateTime": "2025-01-01T00:00:00Z"
        }
      },
      "gtin": "string",
      "inventory": 0,
      "unitPrice": 0
    },
    "account": {}
  },
  "description": "string",
  "unitOfMeasure": {
    "code": "string",
    "displayName": "string",
    "symbol": "string",
    "unitConversion": {
      "toUnitOfMeasure": "string",
      "fromToConversionRate": 0,
      "picture": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "width": 0,
          "height": 0,
          "contentType": "string",
          "content@odata.mediaEditLink": "string",
          "content@odata.mediaReadLink": "string"
        }
      ],
      "defaultDimensions": [
        {
          "parentId": "00000000-0000-0000-0000-000000000000",
          "dimensionId": "00000000-0000-0000-0000-000000000000",
          "dimensionCode": "string",
          "dimensionValueId": "00000000-0000-0000-0000-000000000000",
          "dimensionValueCode": "string",
          "postingValidation": "string",
          "account": {},
          "dimension": {},
          "dimensionValue": {}
        }
      ],
      "itemCategory": {
        "id": "00000000-0000-0000-0000-000000000000",
        "code": "string",
        "displayName": "string",
        "lastModifiedDateTime": "2025-01-01T00:00:00Z"
      }
    },
    "picture": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "width": 0,
        "height": 0,
        "contentType": "string",
        "content@odata.mediaEditLink": "string",
        "content@odata.mediaReadLink": "string"
      }
    ],
    "defaultDimensions": [
      {
        "parentId": "00000000-0000-0000-0000-000000000000",
        "dimensionId": "00000000-0000-0000-0000-000000000000",
        "dimensionCode": "string",
        "dimensionValueId": "00000000-0000-0000-0000-000000000000",
        "dimensionValueCode": "string",
        "postingValidation": "string",
        "account": {},
        "dimension": {},
        "dimensionValue": {}
      }
    ],
    "itemCategory": {
      "id": "00000000-0000-0000-0000-000000000000",
      "code": "string",
      "displayName": "string",
      "lastModifiedDateTime": "2025-01-01T00:00:00Z"
    }
  },
  "unitCost": 0,
  "quantity": 0,
  "discountAmount": 0
}

Need more? See the Microsoft Dynamics 365 Business Central guide for connection setup and behaviour shared by every action.

Was this page helpful?