API DOCUMENTATION
    Try Unleashed Now Sandbox

    Sales Invoices

    The Invoices resource allows sales invoices to be listed and viewed. An individual sales invoice details can be viewed by appending its identifier (a GUID formatted as XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX) to the URI.

    The full range of URIs and HTTP Verbs supported are:

    Operation HTTP Action
    List a page of Sales Invoices GET /Invoices/
    View any Sales Invoice GET /Invoices/{invoiceGuid}

    GET Invoices

    Available Filters for GET Invoices
    Filter Description
    customerCode Returns invoices that matches the specific customer code.
    endDate Returns invoices created before a specified date.
    modifiedSince Returns invoices created or edited after a specified date, must be UTC format.
    invoiceNumber Returns a single invoice with the specified invoice number. If set, it overrides all other filters.
    invoiceStatus Returns invoices with the specified status. Multiple selection can be specified as comma separated.For example: invoiceStatus=Completed,Parked. If no invoiceStatus filter is specified, then we exclude "Deleted" by default.
    orderNumber Returns the invoices associated with the Sales Order Number.
    pageSize Specifies the page size for pagination. Default page size is 200 invoices.

    Note: Requesting large numbers of invoices can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests.
    serialBatch False by default. If set to true then the attributes SerialNumbers and BatchNumbers are displayed.
    startDate Returns invoices created after a specified date.
    Filters are used by adding the filter and value to the URI: /Invoices?customerCode=ACME&startDate=2012-01-01

    Note: Date filters should be provided in the ISO format YYYY-MM-DD. The time zone is UTC.

    Tip: To efficiently retrieve a count of the invoices that match a filter, specify a pageSize of 0: /Invoices?invoiceStatus=Parked,Placed&pageSize=0. The default invoicing is by LastModifiedOn descending.

    Available Fields for GET Invoices
    Property Type Length Notes
    BCSubTotal Nullable Decimal Base Currency SubTotal
    BCTaxTotal Nullable Decimal Base Currency TaxTotal
    BCTotal Nullable Decimal Base Currency Total
    Comments String 2048
    CreatedBy String 50
    CreatedOn DateTime
    Currency Currency
    Customer Customer
    DeliveryAddress Address
    DeliveryInstruction String 500 Delivery instruction is retrieved from the Sales Order
    DueDate Nullable DateTime UTC timezone only
    ExchangeRate Decimal
    Guid Guid
    InvoiceDate Nullable DateTime
    InvoiceLines InvoiceLine collection
    InvoiceNumber String 17
    InvoiceStatus String 20
    LastModifiedBy String 50
    LastModifiedOn Nullable DateTime
    OrderNumber String 17
    PaymentTerm String 100
    PostalAddress Address
    QuoteNumber String 17
    SubTotal Decimal
    TaxTotal Decimal
    Total Decimal
    Available Fields for Address
    Property Type Length
    AddressName String 500
    AddressType String 20
    City String 500
    Country String 500
    DeliveryInstruction String 500
    IsDefault Boolean
    Region String 500
    PostalCode String 500
    StreetAddress String 500
    StreetAddress2 String 500
    Suburb String 500
    Available Fields for Currency
    Property Type Length
    CurrencyCode String 3
    DefaultBuyRate Decimal
    DefaultSellRate Decimal
    Description String 200
    Guid Guid
    LastModifiedOn DateTime
    Available Fields for Customer
    Property Type Length Notes
    CurrencyId Integer Only available in JSON Format
    CustomerCode String 500
    CustomerName String 500
    Guid Guid
    LastModifiedOn DateTime
    Available Fields for Invoice Line
    Property Type Length Notes
    BatchNumbers BatchNumber collection
    BCUnitPrice Decimal Base Currency Unit Price
    Comments String 1024
    DiscountRate Decimal
    Guid Guid
    InvoiceQuantity Decimal
    LastModifiedOn Nullable DateTime
    LineNumber Integer
    LineTax Decimal
    LineTaxCode String 50
    LineTotal Decimal
    LineType String It will be noted as "Charge" if it's a Charge Line
    OrderQuantity Decimal
    Product Product
    SerialNumbers SerialNumber collection
    TaxRate Nullable Decimal
    UnitPrice Decimal
    Available Fields for Batch Number
    Property Type Length
    BatchNumber (XML) / Number (JSON) String 50
    ExpiryDate Nullable DateTime
    Quantity Decimal
    Available Fields for Product
    Property Type Length
    Guid Guid
    ProductCode String 100
    ProductDescription String 500
    Available Fields for Serial Number
    Property Type Length
    SerialNumber (XML) / Identifier (JSON) String 50

    Examples for Response GET /Invoices

    show xml example
    show json example

    Use the API Sandbox to see how the object is rendered in JSON or XML.

    Note: An Unleashed account is required before you can use the API Sandbox.

    Trial accounts are also allowed to connect to the API.
    You can register a new account here: Register.