# Get Invoice By

Retrieve invoice details by number, ID, or outlet.
Requires the "View" role in the "Orders" module.




Use one of the following parameter combinations to retrieve an invoice detail:


By Invoice & Outlet Name:
GET /Invoice/Detail?Number=20.05.00157&Outlet=Outlet1


Example Pair:
    > Outlet: Outlet 1
    > Number: 20.05.00157


By Invoice & Outlet ID:
GET /Invoice/Detail?Number=20.05.00157&OutletID=9c8a1b0e-1c9c-4b3f-9a7d-2e5f6a7b8c9d


    Example Pair:
    > OutletID: 9c8a1b0e-1c9c-4b3f-9a7d-2e5f6a7b8c9d
    > Number: 20.05.00157


By Invoice ID:
GET /Invoice/Detail?ID=aad4a789-b802-49c1-b66f-f45fbc7ce17f


    Example:
    > ID: aad4a789-b802-49c1-b66f-f45fbc7ce17f

Endpoint: GET /api/v3/Invoice/Detail
Version: 3.1.0
Security: OAuth2_clientCredentials

## Query parameters:

  - `Number` (string)
    Invoice number
    Example: "20.05.00157"

  - `Outlet` (string)
    Outlet name.
    Example: "Outlet1"

  - `OutletID` (string)
    GUID of Outlet ID.
    Example: "9c8a1b0e-1c9c-4b3f-9a7d-2e5f6a7b8c9d"

  - `ID` (string)
    GUID of Invoice ID.
    Example: "9c8a1b0e-1c9c-4b3f-9a7d-2e5f6a7b8c9d"

## Response 200 fields (application/json):

  - `ID` (string)
    Unique ID of the invoice

  - `Outlet` (string)
    Name of the outlet

  - `Number` (string)
    Number of the invoice transasction

  - `Date` (string)
    Sell date of the invoice transaction

  - `DueDate` (string)
    Due date of the invoice transaction

  - `Tag` (string)
    Channel Tagging system. (ex:Offline / Whatsapp / Shopee / Tokopedia) used in marketplace.dealpos.app. Backwards Compatibility with property request "SalesType"

  - `SalesPerson` (string)
    Sales person name of the invoice transaction

  - `Customer` (object)

  - `Customer.Code` (string)
    Unique Code of the customer

  - `Customer.Email` (string)
    E-mail of the customer

  - `Customer.Mobile` (string)
    Mobile Phone Number of the customer

  - `Customer.Name` (string)
    Name of the customer

  - `Customer.Phone` (string)
    Phone number of the customer

  - `CreatorID` (string)
    Unique ID of the creator

  - `Created` (string)
    Invoice created Transaction Date by system

  - `Discount1` (integer)
    Percentage of discount 1

  - `Discount2` (integer)
    Percentage of discount 2

  - `DiscountAmount` (number)
    Amount of Discount amount-based

  - `Gross` (number)
    Total amount of the transaction before discounted

  - `DiscountTotal` (number)
    Total accumulation of the discounts

  - `Deposit` (number)
    Total amount of the deposit used in the transaction

  - `TaxType` (string)
    Type name of the tax

  - `Tax` (number)
    Total amount of the taxes

  - `TaxRate` (number)
    Rate of Tax in percentage

  - `Sales` (number)
    Total amount of the sales after subtraction

  - `Surcharge` (number)
    Additional expense (ex: from credit card)

  - `SalesNTax` (number)
    Total amount of sales after taxes

  - `Coupon` (string)
    Promotion Coupon Key

  - `Note` (string)
    Note of the invoice transaction

  - `PointUsed` (integer)
    Total point used in the transaction

  - `PointsEarned` (integer)
    Total point earned from the transaction

  - `Fulfillment` (string)
    delivery status / progres of the invoice
    Enum: "Sent", "Unsent", "Partial", "Returned"

  - `LogisticServiceCode` (string)
    Code of Logistic Service Option

  - `Payment` (string)
    payment status / state of the invoice

  - `Void` (string)
    Void state / status of the invoice

  - `Bin` (boolean)
    Recycle bin state/status of the invoice

  - `ReferenceInvoiceNumber` (string)
    Another Invoice that is associated with this Invoice ex: SalesReturn scenario, null when it is normal Sales transaction

  - `EReceipt` (string)
    E-Receipt URL of the invoice transaction

  - `Variants` (array)

  - `Variants.VariantID` (string)
    Product Variant ID

  - `Variants.Name` (string)
    Product Variant Name

  - `Variants.Code` (string)
    Product Variant Code

  - `Variants.Quantity` (integer)
    Quantity of the product variant

  - `Variants.UnitQuantity` (integer)
    Unit Quantity Messurement of the product variant

  - `Variants.Cost` (integer)
    Unit Cost of the product variant

  - `Variants.Price` (integer)
    Selling Price of the product variant

  - `Variants.PriceOriginal` (integer)
    Original Price (before discounted) of the product variant

  - `Variants.Discount` (integer)
    Discount Percentage (%) of the product variant

  - `Variants.DiscountAmount` (integer)
    Discount Amount of the product variant

  - `Variants.Taxable` (boolean)
    Taxable state/status of the invoice transaction

  - `Variants.LoyaltyPoint` (boolean)
    Loyalty state/status of the invoice transaction

  - `Variants.Expense` (integer)
    Additional Expense of the product variant

  - `Variants.Sales` (integer)
    Net Sales for the Product (after deducted by Discount - DiscountAmount - TaxInclude)

  - `Variants.Tax` (integer)
    Tax applied for the product depending on chosen TaxType (Rate + Calculation)

  - `Variants.Commission` (integer)
    Sales commision of the invoice transaction

  - `Variants.SalesName` (string)
    Sales Person Name of the transaction

  - `Variants.PriceTypeID` (integer)
    Sales price type of the transaction

  - `Variants.Note` (string)
    Product Variant Note of the invoice transaction

  - `Variants.Index` (integer)
    Index of the product variant in the invoice transaction

  - `OutboundLogistics` (array)

  - `OutboundLogistics.Outlet` (string)
    Outlet_Name_of_Outbound_Logistic

  - `OutboundLogistics.Number` (string)
    Outbound_Logistic_Number

  - `OutboundLogistics.Date` (string)
    Date of Outbound Logistic

  - `Payments` (array)

  - `Payments.Date` (string)
    Date of the payment

  - `Payments.Amount` (integer)
    Total amount of the payment

  - `Payments.BuyerPaidAmount` (integer)
    Total amount paid by the buyer

  - `Payments.Method` (string)
    Payment method of the invoice transaction

  - `Payments.Code` (string)
    Code of the payment method

  - `Payments.Note` (string)
    Note of the payment method

## Response 400 fields (application/json):

  - `Message` (string)
    Error message

## Response 500 fields (application/json):

  - `Message` (string)
    Error message

  - `ExceptionMessage` (string)
    Exception message

  - `ExceptionType` (string)
    Exception type

  - `StackTrace` (string)
    Stack trace of the exception