HTTP Verb/Method:

GET 

URL Format:

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

Returns:

Metadata for all invoices of the order will return upon a successful request.

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

Parameter

Description

OrderID

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

Property

Description

Amount

The dollar amount of the invoice displays.

Created

Returned here is the creation date of the invoice document.

This date is formatted in “CCYY-MM-DDThh:mm:ss” format (see Document API Date Format).

CreatedBy

The MoversSuite user that created the invoice is returned in this property.

Description

This is the text description of the invoice.

ImageUrl

The URL containing the location of the invoice document.  If this value is null, then no image of the invoice is on file.

InvoiceNumber

The specific number assigned to the invoice for this order is returned.    The sequence is appended to the Order Number following a slash, e.g. “/2” for invoice “2” on an order.

Invoiced

The date and time of the invoice display within this property.

This date is formatted in “CCYY-MM-DDThh:mm:ss” format (see Document API Date Format).

Name

The name of the document or the file name of the document is returned in this property.

OrderID

This is the identification for the order associated to the invoice.  The OrderID is typically the primary key of the order in the Orders table (Order.PriKey).

OrderUrl

This property contains the URL that references the metadata for the order associated to the invoice.

Status

One of the following status values is returned with this property:

“Invoice” indicates a an active, generated invoice

“Void” indicates that the invoice has been voided

“Draft” indicates that the invoice is in a draft state

Type

Invoices will always be assigned to a type of “MS Invoice.”