Get Invoice Metadata by Number

 

This method returns metadata for an invoice for a specified invoice number and order.

 

HTTP Verb/Method:

GET 

URL Format:

http://server/api/invoices/{OrderID}/{InvNum}

Returns:

Metadata for an invoice document returns upon a successful request.

An error is returned if the invoice metadata cannot be found.

 

The following table lists the parameter available for this method request.

 

Parameter

Description

OrderID

Enter the primary key (Orders.PriKey) of the requested MoversSuite order. 

InvNum

Enter the sequence or invoice number assigned to the document for the order, such as “1, 2, 3, …”  For example, invoice “U1900-12789-2/3” has an invoice number of “3”.

The InvNum is found through the InvoiceNumber property value returned from a Get All Metadata by Order method request (when the Source is “Invoices”).

 

Refer to the Request Return section in Get All Invoice Metadata by Order for property descriptions returned by this method.