Create or update invoice..

post

https://api.hikeup.com/api/v1/sales/create

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Invoice model

Sale detail

doCalculation

boolean

if true then hike will calcuate summary and false so in hike will put the data as given in model

number

string

required

Sale invoice number

transactionDate

date-time

Sale's Transaction date and time

finalizeDate

date-time

Sale's Transaction completed date and time

customerId

int32

Sale's customer primary id

customerName

string

Sale's customer full name

customerGroupId

int32

Sale's customer group primary id if customer associated with group

customerEmailId

string

Sale's customer email address

customerPhone

string

Sale's customer phone number

customerGroupDiscount

double

Sale's customer group discount in percentage

customerGroupDiscountNote

string

Sale's customer group pricing discount note

outletId

int32

Outlet primary id

registerid

int32

customer first name

registerName

string

registerClosureId

int32

Sale's cash register closure primary id

barcode

string

Sale's bracode

status

string

enum

Sale's status

paymentStatus

string

enum

Sale's status

taxInclusive

boolean

Sale's tax rule

applyTaxAfterDiscount

boolean

Sale's tax apply rule after discount or not

discountIsAsPercentage

boolean

Sale's discount apply in percentage or amount

discountValue

double

Sale's discount amount or percentage value

discountNote

string

Sale's discount note

tipIsAsPercentage

boolean

Sale's tip apply in percentage or amount

tipValue

double

Sale's tip apply in percentage or amount value

subTotal

double

Sale's sub total

giftCardTotal

double

Sale's giftcard total

totalDiscount

double

Sale's total discount

totalShippingCost

double

Sale's total shipping cost

shippingDiscount

double

Sale's total shipping discount amount

shippingTaxId

int32

Sale's shipping tax primary id

shippingTaxRate

double

Sale's shipping tax rate value

shippingTaxAmount

double

Sale's total shipping tax amount

otherCharges

double

Sale's other total changes

totalTax

double

Sale's total tax amount

totalTip

double

Sale's total tip amount

roundingAmount

double

Sale's total rounding percision amount

netAmount

double

Sale's total net amount

totalPaid

double

Sales total paid amount

totalTender

double

Sale's total tendered amount

changeAmount

double

Sale's total change given amount

currency

string

Sale's currency

servedBy

int64

Sale's who have proceed primary id

servedByName

string

Sale's who have proceed by name

note

string

Sale's note

creationTime

date-time

Record first created date

lastModificationTime

date-time

Record last update date

referenceInvoiceId

int32

Sale's reference invoice id when its refunded

referenceNote

string

Sale's reference invoice note

isReStockWhenRefund

boolean

Sale's stock want to re-stock or not while refund

trackNumber

string

Sale's shipping track number

trackURL

string

Sale's shipping track url

trackDetails

string

Sale's shipping tracking detail

doNotUpdateInvenotry

boolean

Sale's item stock if do not update in stock

thirdPartySyncStatus

string

enum

Sale's third pary sync status

Allowed:

customerCurrentLoyaltyPoints

double

Customer current loyalty points

loyaltyPoints

double

Loyalty point amount earned

loyaltyPointsValue

double

Actual loyalty pount earned

deliveryAddressId

int32

DeliveryAddressId

deliveryAddress

object

Customer's address details

invoiceLineItems

array of objects

Sale's line item

invoiceLineItems

invoicePayments

array of objects

Sale's payments

invoicePayments

invoiceShipping

object

shippingStatus

string

enum

Sale's Shipping Status

isActive

boolean

Is active or not?

int32

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

200OK