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 |
Provide the primary key (Orders.PriKey) of the requested MoversSuite order. |
InvNum |
Provide the invoice number for the requested document on the order. This is the specific identifier for the invoice document. It is in the format of a single number, e.g. 23902, or in the format of the Order Number followed by “/”, and then invoice sequence, e.g. “U1900-12789-6/1.” You can identify the value for the InvNum parameter by referencing the value returned for the InvoiceNumber property through 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.