Skip to content

MatchedInvoiceItems

Get the list of Matched Invoice Items

Path

GET /odata/MatchedInvoiceItems

Description

Returns the paged list of the existing Matched Invoice Items within a logged organization. You can filter the results by the strict match using the $filter parameter–entity eq ‘string’. Or filter the results by the partial match using $filter=contains parameter–contains(entity, ‘string’).

Note

This endpoint does not support logical operators (in, gt, ge, lt, le) for data filtering.

Request parameters

Parameter
Explanation
api-version: string default: 1.0
in header		 The requested API version.
$search: string
in query		 Picks the value in all possible fields.
$filter: string
in query		 Filters the results, based on a Boolean condition.
$orderby: string
in query		 Sorts the results.
$top: string
in query		 Returns only the first n results.
$skip: string
in query		 Skips the first n results.
Authorization: string default:
Bearer access_token
in header		 Specify the type of the token (bearer) and then insert the access_token, which was obtained during authentication.

Responses

Response
Explanation
200 OK OK
400 Bad Request Incorrect input data or organization ID does not match with the organization ID user is logged in.
400 Bad Request The limit for the $top query has been exceeded. The value from the incoming request is 'N' (N is your value from the request). You can find the data on the current limit here.
401 Unauthorized Incorrect specified access_token or access_token got expired.
403 Forbidden User doesn’t have appropriate privileges.
500 Internal Server Error Server encountered an unexpected condition that prevented it from fulfilling the request.

Properties

Property
Explanation
apMatchedInvoiceItemId:
string (uuid)		 Unique Identifier of the Account Payable Matched Invoice Item
matchedInvoiceItemNo:
integer (int32)		 Number of the Matched Invoice Item
matchedInvoiceId: string (uuid) Unique Identifier of the Matched Invoice
matchedInvoiceNo: string Number of the Matched Invoice
purchaseOrderId: string (uuid) Unique Identifier of the Purchase Order
purchaseOrderNo: string Number of the Purchase Order
poReceiptItemId: string (uuid) Unique Identifier of the Purchase Order Receipt Item
returnItemId: string (uuid) Unique Identifier of the Return Item
invoiceQuantity: integer (int32) Specified Quantity in the Invoice
invoiceUOM: string Specified Unit of Measure in the Invoice
invoiceConversionFactor:
integer (int32)		 Specified Number of Stock Keeping Units in another Unit of Measure in the Invoice
invoicePrice: number (double) Specified Price in the Invoice
notes: string Comments about the Matched Invoice Item
departmentGLCode: string General Ledger Code of the Department
glCode: string General Ledger Code
lineItemTypeId: integer (int32) Unique Identifier of the Line Item Type
lineItemType: string Type of the Line Item
qtyApprovalTypeId: integer
(int32)		 Unique Identifier of the Quantity Approval Type
qtyApprovalType: string Approval Type of the Quantity
priceApprovalTypeId:
integer (int32)		 Unique Identifier of the Price Approval Type
priceApprovalType: string Approval Type of the Price
inventoryNo: string Identification code of the Inventory Item
inventoryDescription: string Description of the Inventory Item
vendorItemNo: string Code that is used by the Vendor for the Item identification
manufacturerName: string Name of the Manufacturer
manufacturerItemNo: string Number of the Manufacturer Item
dateCreated: string (date-time) Date when the Matched Invoice Item was added
createdBy: string (uuid) Unique Identifier of the user who created the Matched Invoice Item
createdByName: string Name of the user who created the Matched Invoice Item
lastUpdated: string (date-time) Last Date when the Matched Invoice Item was updated
lastUpdatedBy: string (uuid) Unique Identifier of the last user who updated the Matched Invoice Item
lastUpdatedByName: string Name of the last user who updated the Matched Invoice Item
isTaxable: boolean Is the Matched Invoice Item taxable or not?
Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response Example (200 OK)
{
  "items": [
    {
      "apMatchedInvoiceItemId": "00000000-0000-0000-0000-000000000000",
      "matchedInvoiceItemNo": "integer (int32)",
      "matchedInvoiceId": "00000000-0000-0000-0000-000000000000",
      "matchedInvoiceNo": "string",
      "purchaseOrderId": "00000000-0000-0000-0000-000000000000",
      "purchaseOrderNo": "string",
      "poReceiptItemId": "00000000-0000-0000-0000-000000000000",
      "returnItemId": "00000000-0000-0000-0000-000000000000",
      "invoiceQuantity": "integer (int32)",
      "invoiceUOM": "string",
      "invoiceConversionFactor": "integer (int32)",
      "invoicePrice": "number (double)",
      "notes": "string",
      "departmentGLCode": "string",
      "glCode": "string",
      "lineItemTypeId": "integer (int32)",
      "lineItemType": "string",
      "qtyApprovalTypeId": "integer (int32)",
      "qtyApprovalType": "string",
      "priceApprovalTypeId": "integer (int32)",
      "priceApprovalType": "string",
      "inventoryNo": "string",
      "inventoryDescription": "string",
      "vendorItemNo": "string",
      "manufacturerName": "string",
      "manufacturerItemNo": "string",
      "dateCreated": "string (date-time)",
      "createdBy": "00000000-0000-0000-0000-000000000000",
      "createdByName": "string",
      "lastUpdated": "string (date-time)",
      "lastUpdatedBy": "00000000-0000-0000-0000-000000000000",
      "lastUpdatedByName": "string",
      "isTaxable": "boolean"
    }
  ],
  "nextPageLink": "string",
  "count": "integer (int64)"
}

Get the specified Matched Invoice Item

Path

GET /odata/MatchedInvoiceItems({matchedInvoiceItemId})

Description

Returns the details of the Matched Invoice Item specified by ID.

Request parameters

Parameter
Explanation
matchedInvoiceItemId: string (uuid)
required
in path		 Enter the ID of the Matched Invoice Item here.
api-version: string default: 1.0
in header		 The requested API version.
Authorization: string default:
Bearer access_token
in header		 Specify the type of the token (bearer) and then insert the access_token, which was obtained during authentication.

Responses

Response
Explanation
200 OK OK
400 Bad Request Incorrect input data or organization ID does not match with the organization ID user is logged in.
401 Unauthorized Incorrect specified access_token or access_token got expired.
403 Forbidden User doesn’t have appropriate privileges.
404 Not Found Specified ID is absent in the system.
500 Internal Server Error Server encountered an unexpected condition that prevented it from fulfilling the request.

Properties

Property
Explanation
apMatchedInvoiceItemId:
string (uuid)		 Unique Identifier of the Account Payable Matched Invoice Item
matchedInvoiceItemNo:
integer (int32)		 Number of the Matched Invoice Item
matchedInvoiceId: string (uuid) Unique Identifier of the Matched Invoice
matchedInvoiceNo: string Number of the Matched Invoice
purchaseOrderId: string (uuid) Unique Identifier of the Purchase Order
purchaseOrderNo: string Number of the Purchase Order
poReceiptItemId: string (uuid) Unique Identifier of the Purchase Order Receipt Item
returnItemId: string (uuid) Unique Identifier of the Return Item
invoiceQuantity: integer (int32) Specified Quantity in the Invoice
invoiceUOM: string Specified Unit of Measure in the Invoice
invoiceConversionFactor:
integer (int32)		 Specified Number of Stock Keeping Units in another Unit of Measure in the Invoice
invoicePrice: number (double) Specified Price in the Invoice
notes: string Comments about the Matched Invoice Item
departmentGLCode: string General Ledger Code of the Department
glCode: string General Ledger Code
lineItemTypeId: integer (int32) Unique Identifier of the Line Item Type
lineItemType: string Type of the Line Item
qtyApprovalTypeId: integer
(int32)		 Unique Identifier of the Quantity Approval Type
qtyApprovalType: string Approval Type of the Quantity
priceApprovalTypeId:
integer (int32)		 Unique Identifier of the Price Approval Type
priceApprovalType: string Approval Type of the Price
inventoryNo: string Identification code of the Inventory Item
inventoryDescription: string Description of the Inventory Item
vendorItemNo: string Code that is used by the Vendor for the Item identification
manufacturerName: string Name of the Manufacturer
manufacturerItemNo: string Number of the Manufacturer Item
dateCreated: string (date-time) Date when the Matched Invoice Item was added
createdBy: string (uuid) Unique Identifier of the user who created the Matched Invoice Item
createdByName: string Name of the user who created the Matched Invoice Item
lastUpdated: string (date-time) Last Date when the Matched Invoice Item was updated
lastUpdatedBy: string (uuid) Unique Identifier of the last user who updated the Matched Invoice Item
lastUpdatedByName: string Name of the last user who updated the Matched Invoice Item
isTaxable: boolean Is the Matched Invoice Item taxable or not?
Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response example (200 OK)
{
  "apMatchedInvoiceItemId": "00000000-0000-0000-0000-000000000000",
  "matchedInvoiceItemNo": "integer (int32)",
  "matchedInvoiceId": "00000000-0000-0000-0000-000000000000",
  "matchedInvoiceNo": "string",
  "purchaseOrderId": "00000000-0000-0000-0000-000000000000",
  "purchaseOrderNo": "string",
  "poReceiptItemId": "00000000-0000-0000-0000-000000000000",
  "returnItemId": "00000000-0000-0000-0000-000000000000",
  "invoiceQuantity": "integer (int32)",
  "invoiceUOM": "string",
  "invoiceConversionFactor": "integer (int32)",
  "invoicePrice": "number (double)",
  "notes": "string",
  "departmentGLCode": "string",
  "glCode": "string",
  "lineItemTypeId": "integer (int32)",
  "lineItemType": "string",
  "qtyApprovalTypeId": "integer (int32)",
  "qtyApprovalType": "string",
  "priceApprovalTypeId": "integer (int32)",
  "priceApprovalType": "string",
  "inventoryNo": "string",
  "inventoryDescription": "string",
  "vendorItemNo": "string",
  "manufacturerName": "string",
  "manufacturerItemNo": "string",
  "dateCreated": "string (date-time)",
  "createdBy": "00000000-0000-0000-0000-000000000000",
  "createdByName": "string",
  "lastUpdated": "string (date-time)",
  "lastUpdatedBy": "00000000-0000-0000-0000-000000000000",
  "lastUpdatedByName": "string",
  "isTaxable": "boolean"
}