Vendor Invoice by ID

Prev Next
Get
/public/v1/inventory/invoices/{id}

Retrieves a specified invoice

Security

The requesting user must have the following permission to retrieve a vendor invoice:

  • Food → AP Invoices → View AP Invoices Within Food

This endpoint also returns AP credit memo records. To receive those, the user additionally needs:

  • Food → AP Credit Memos → View AP Credit Memos Within Food
Security
HTTP
Type Bearer
Header parameters
x-r365-context-tenant-id
stringRequired

Identifies the R365 tenant the request applies to. Required on every request.

Path parameters
id
string (uuid) Required

Identifier of the invoice

Responses
200

invoice entity

Expand All
object

An Accounts Payable Invoice or Credit Memo.

id
string (uuid)

The unique identifier for the invoice.

transactionType
string | null

The type of transaction, either Invoice or Credit Memo.

name
string | null

The invoice name.

number
string | null

The invoice number.

amount
number (double)

The total amount of the invoice.

isPaid
boolean | null

Indicates whether the invoice has been paid.

creditExpected
number (double) | null

The amount of credit expected on the invoice.

overhead
number (double) | null

The amount of overhead to be applied to invoice detail rows.

comment
string | null

A user comment for the invoice.

status
string | null

The approval status of the invoice.

date
string (date)

The date of the invoice.

documentDate
string (date)

The document date of the invoice.

dueDate
string (date) | null

The due date of the invoice.

legalEntity
object (LegalEntitiesLegalEntityReference)

A reference to a legal entity.

id
string (uuid)

Unique identifier of the legal entity.

name
string | null

Display name of the legal entity.

location
object (InventoryLocationReference)

Represents a reference to a location.

id
string (uuid)

The id of the location.

name
string | null

The name of the location.

number
string | null

The location number.

vendor
object (VendorReference)

A reference to a vendor.

id
string (uuid)

Unique identifier of the vendor.

name
string | null

Display name of the vendor.

number
string | null

Number assigned to the vendor.

purchaseOrder
object (PurchaseOrderReference)

A reference to a purchase order.

id
string (uuid)

Unique identifier of the purchase order.

name
string | null

Display name of the purchase order.

createdBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

createdOn
string (date-time) | null

The date the invoice was created.

modifiedBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

modifiedOn
string (date-time) | null

The date the invoice was last modified.

approvedBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

approvedOn
string (date-time) | null

The date the invoice was approved.

completedBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

completedOn
string (date-time) | null

The date the invoice was completed.

details
Array of object | null

The invoice line item details.

object

A detail for an Accounts Payable Invoice or Credit Memo.

id
string (uuid)

The unique identifier for the detail.

comment
string | null

The detail comment.

eachAmount
number (double)

The amount of each item in the line item.

overhead
number (double)

Overhead [ex: freight] that should be added to the line item total.

generalLedgerAccount
object (GeneralLedgerAccountReference)

A reference to a General Ledger Account.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

item
object (PublicItemReference)

A reference to an item.

id
string (uuid)

Unique identifier of the public item.

name
string | null

Display name of the public item.

number
string | null

Number assigned to the public item.

itemType
string | null
location
object (InventoryLocationReference)

Represents a reference to a location.

id
string (uuid)

The id of the location.

name
string | null

The name of the location.

number
string | null

The location number.

quantity
number (double)

The quantity of the item.

quantityOrdered
number (double) | null

The quantity ordered for this line item, if linked to a purchase order. This is defined in the same unit of measure as the quantity field for what was received on this invoice.

total
number (double)

The total amount of the line item.

unitOfMeasure
object (InventoryUnitOfMeasureReference)

A reference to a unit of measure.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

vendorItem
object (VendorItemReference)

A reference to a vendor item.

id
string (uuid) | null

Unique identifier of the vendor item.

name
string | null

Display name of the vendor item.

number
string | null

Number assigned to the vendor item.

brandItemNumber
string | null
purchaseUnitOfMeasure
object (InventoryUnitOfMeasureReference)

A reference to a unit of measure.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

splitUnitOfMeasure
object (InventoryUnitOfMeasureReference)

A reference to a unit of measure.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

Expand All
object

An Accounts Payable Invoice or Credit Memo.

id
string (uuid)

The unique identifier for the invoice.

transactionType
string | null

The type of transaction, either Invoice or Credit Memo.

name
string | null

The invoice name.

number
string | null

The invoice number.

amount
number (double)

The total amount of the invoice.

isPaid
boolean | null

Indicates whether the invoice has been paid.

creditExpected
number (double) | null

The amount of credit expected on the invoice.

overhead
number (double) | null

The amount of overhead to be applied to invoice detail rows.

comment
string | null

A user comment for the invoice.

status
string | null

The approval status of the invoice.

date
string (date)

The date of the invoice.

documentDate
string (date)

The document date of the invoice.

dueDate
string (date) | null

The due date of the invoice.

legalEntity
object (LegalEntitiesLegalEntityReference)

A reference to a legal entity.

id
string (uuid)

Unique identifier of the legal entity.

name
string | null

Display name of the legal entity.

location
object (InventoryLocationReference)

Represents a reference to a location.

id
string (uuid)

The id of the location.

name
string | null

The name of the location.

number
string | null

The location number.

vendor
object (VendorReference)

A reference to a vendor.

id
string (uuid)

Unique identifier of the vendor.

name
string | null

Display name of the vendor.

number
string | null

Number assigned to the vendor.

purchaseOrder
object (PurchaseOrderReference)

A reference to a purchase order.

id
string (uuid)

Unique identifier of the purchase order.

name
string | null

Display name of the purchase order.

createdBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

createdOn
string (date-time) | null

The date the invoice was created.

modifiedBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

modifiedOn
string (date-time) | null

The date the invoice was last modified.

approvedBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

approvedOn
string (date-time) | null

The date the invoice was approved.

completedBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

completedOn
string (date-time) | null

The date the invoice was completed.

details
Array of object | null

The invoice line item details.

object

A detail for an Accounts Payable Invoice or Credit Memo.

id
string (uuid)

The unique identifier for the detail.

comment
string | null

The detail comment.

eachAmount
number (double)

The amount of each item in the line item.

overhead
number (double)

Overhead [ex: freight] that should be added to the line item total.

generalLedgerAccount
object (GeneralLedgerAccountReference)

A reference to a General Ledger Account.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

item
object (PublicItemReference)

A reference to an item.

id
string (uuid)

Unique identifier of the public item.

name
string | null

Display name of the public item.

number
string | null

Number assigned to the public item.

itemType
string | null
location
object (InventoryLocationReference)

Represents a reference to a location.

id
string (uuid)

The id of the location.

name
string | null

The name of the location.

number
string | null

The location number.

quantity
number (double)

The quantity of the item.

quantityOrdered
number (double) | null

The quantity ordered for this line item, if linked to a purchase order. This is defined in the same unit of measure as the quantity field for what was received on this invoice.

total
number (double)

The total amount of the line item.

unitOfMeasure
object (InventoryUnitOfMeasureReference)

A reference to a unit of measure.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

vendorItem
object (VendorItemReference)

A reference to a vendor item.

id
string (uuid) | null

Unique identifier of the vendor item.

name
string | null

Display name of the vendor item.

number
string | null

Number assigned to the vendor item.

brandItemNumber
string | null
purchaseUnitOfMeasure
object (InventoryUnitOfMeasureReference)

A reference to a unit of measure.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

splitUnitOfMeasure
object (InventoryUnitOfMeasureReference)

A reference to a unit of measure.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

Expand All
object

An Accounts Payable Invoice or Credit Memo.

id
string (uuid)

The unique identifier for the invoice.

transactionType
string | null

The type of transaction, either Invoice or Credit Memo.

name
string | null

The invoice name.

number
string | null

The invoice number.

amount
number (double)

The total amount of the invoice.

isPaid
boolean | null

Indicates whether the invoice has been paid.

creditExpected
number (double) | null

The amount of credit expected on the invoice.

overhead
number (double) | null

The amount of overhead to be applied to invoice detail rows.

comment
string | null

A user comment for the invoice.

status
string | null

The approval status of the invoice.

date
string (date)

The date of the invoice.

documentDate
string (date)

The document date of the invoice.

dueDate
string (date) | null

The due date of the invoice.

legalEntity
object (LegalEntitiesLegalEntityReference)

A reference to a legal entity.

id
string (uuid)

Unique identifier of the legal entity.

name
string | null

Display name of the legal entity.

location
object (InventoryLocationReference)

Represents a reference to a location.

id
string (uuid)

The id of the location.

name
string | null

The name of the location.

number
string | null

The location number.

vendor
object (VendorReference)

A reference to a vendor.

id
string (uuid)

Unique identifier of the vendor.

name
string | null

Display name of the vendor.

number
string | null

Number assigned to the vendor.

purchaseOrder
object (PurchaseOrderReference)

A reference to a purchase order.

id
string (uuid)

Unique identifier of the purchase order.

name
string | null

Display name of the purchase order.

createdBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

createdOn
string (date-time) | null

The date the invoice was created.

modifiedBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

modifiedOn
string (date-time) | null

The date the invoice was last modified.

approvedBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

approvedOn
string (date-time) | null

The date the invoice was approved.

completedBy
object (GlAccountUserReference)

A reference to a user.

id
string (uuid)

The unique identifier of the user.

name
string | null

The name of the user.

completedOn
string (date-time) | null

The date the invoice was completed.

details
Array of object | null

The invoice line item details.

object

A detail for an Accounts Payable Invoice or Credit Memo.

id
string (uuid)

The unique identifier for the detail.

comment
string | null

The detail comment.

eachAmount
number (double)

The amount of each item in the line item.

overhead
number (double)

Overhead [ex: freight] that should be added to the line item total.

generalLedgerAccount
object (GeneralLedgerAccountReference)

A reference to a General Ledger Account.

id
string (uuid)

Unique identifier of the general ledger account.

name
string | null

Display name of the general ledger account.

number
string | null

Number assigned to the general ledger account.

item
object (PublicItemReference)

A reference to an item.

id
string (uuid)

Unique identifier of the public item.

name
string | null

Display name of the public item.

number
string | null

Number assigned to the public item.

itemType
string | null
location
object (InventoryLocationReference)

Represents a reference to a location.

id
string (uuid)

The id of the location.

name
string | null

The name of the location.

number
string | null

The location number.

quantity
number (double)

The quantity of the item.

quantityOrdered
number (double) | null

The quantity ordered for this line item, if linked to a purchase order. This is defined in the same unit of measure as the quantity field for what was received on this invoice.

total
number (double)

The total amount of the line item.

unitOfMeasure
object (InventoryUnitOfMeasureReference)

A reference to a unit of measure.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

vendorItem
object (VendorItemReference)

A reference to a vendor item.

id
string (uuid) | null

Unique identifier of the vendor item.

name
string | null

Display name of the vendor item.

number
string | null

Number assigned to the vendor item.

brandItemNumber
string | null
purchaseUnitOfMeasure
object (InventoryUnitOfMeasureReference)

A reference to a unit of measure.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

splitUnitOfMeasure
object (InventoryUnitOfMeasureReference)

A reference to a unit of measure.

id
string (uuid)

Unique identifier of the unit of measure.

name
string | null

Display name of the unit of measure.

400

Bad Request — a parameter value is malformed, of the wrong type, or outside its allowed range.

401

Unauthorized — the bearer token is missing, invalid or expired, or is not valid for the specified tenant.

403

Forbidden — the caller lacks the permission required for this operation.

404

Not Found — the requested resource does not exist, or the supplied continuation token is unknown or has expired.

409

Conflict — the request conflicts with the current state of the resource and cannot be applied.

422

Unprocessable Entity — a required parameter is missing, or a supplied parameter value is invalid.

429

Too Many Requests — the caller has exceeded the rate limit; retry after a short delay.

500

Internal Server Error — an unexpected error occurred while processing the request.