ETASCOM CRM V3 - Documentation API
Storybook
GitHub
Preparing search index...
app/(protected)/sales/orders/hooks/use-orders
useOrderMutations
Function useOrderMutations
useOrderMutations
()
:
{
create
:
UseMutationResult
<
any
,
Error
,
{
number
:
string
;
clientId
:
string
;
clientOrderNumber
:
string
;
orderDate
:
string
;
deliveryDate
?:
string
;
requestedDepartureDate
?:
string
;
confirmedDepartureDate
?:
string
;
status
:
|
"DRAFT"
|
"CANCELLED"
|
"COMPLETED"
|
"CONFIRMED"
|
"PENDING_CONFIRMATION"
|
"IN_PRODUCTION"
|
"READY_TO_SHIP"
|
"SHIPPED"
|
"DELIVERED"
|
"PARTIAL"
;
totalAmount
:
number
;
currencyId
:
string
;
salesOfferId
?:
string
;
opportunityId
?:
string
;
transportDelay
?:
number
;
notes
?:
string
;
lines
:
{
id
?:
string
;
finishedProductId
?:
string
;
description
:
string
;
quantity
:
number
;
unitPrice
:
number
;
totalPrice
:
number
;
taxId
?:
string
;
taxRate
:
number
;
taxAmount
:
number
;
deliveredQuantity
:
number
;
remainingQuantity
:
number
;
notes
?:
string
;
sequence
:
number
;
clientProductCode
?:
string
;
requestedDepartureDate
?:
string
;
confirmedDepartureDate
?:
string
;
unitOfMeasureId
?:
string
;
unitOfPriceId
?:
string
;
salesMultiple
?:
number
;
minimumQuantity
?:
number
;
}
[]
;
}
,
unknown
,
>
;
update
:
UseMutationResult
<
any
,
Error
,
{
id
:
string
;
number
?:
string
;
clientId
?:
string
;
clientOrderNumber
?:
string
;
orderDate
?:
string
;
requestedDepartureDate
?:
string
;
confirmedDepartureDate
?:
string
;
status
?:
|
"DRAFT"
|
"CANCELLED"
|
"COMPLETED"
|
"CONFIRMED"
|
"PENDING_CONFIRMATION"
|
"IN_PRODUCTION"
|
"READY_TO_SHIP"
|
"SHIPPED"
|
"DELIVERED"
|
"PARTIAL"
;
totalAmount
?:
number
;
currencyId
?:
string
;
salesOfferId
?:
string
;
transportDelay
?:
number
;
notes
?:
string
;
lines
?:
{
id
?:
string
;
finishedProductId
?:
string
;
description
?:
string
;
quantity
?:
number
;
unitPrice
?:
number
;
totalPrice
?:
number
;
taxId
?:
string
;
taxRate
?:
number
;
taxAmount
?:
number
;
deliveredQuantity
?:
number
;
remainingQuantity
?:
number
;
notes
?:
string
;
sequence
?:
number
;
clientProductCode
?:
string
;
requestedDepartureDate
?:
string
;
confirmedDepartureDate
?:
string
;
unitOfMeasureId
?:
string
;
unitOfPriceId
?:
string
;
salesMultiple
?:
number
;
minimumQuantity
?:
number
;
}
[]
;
}
,
unknown
,
>
;
delete
:
UseMutationResult
<
any
,
Error
,
string
,
unknown
>
;
updateStatus
:
UseMutationResult
<
any
,
Error
,
{
orderId
:
string
;
status
:
string
}
,
unknown
,
>
;
}
Returns
{
create
:
UseMutationResult
<
any
,
Error
,
{
number
:
string
;
clientId
:
string
;
clientOrderNumber
:
string
;
orderDate
:
string
;
deliveryDate
?:
string
;
requestedDepartureDate
?:
string
;
confirmedDepartureDate
?:
string
;
status
:
|
"DRAFT"
|
"CANCELLED"
|
"COMPLETED"
|
"CONFIRMED"
|
"PENDING_CONFIRMATION"
|
"IN_PRODUCTION"
|
"READY_TO_SHIP"
|
"SHIPPED"
|
"DELIVERED"
|
"PARTIAL"
;
totalAmount
:
number
;
currencyId
:
string
;
salesOfferId
?:
string
;
opportunityId
?:
string
;
transportDelay
?:
number
;
notes
?:
string
;
lines
:
{
id
?:
string
;
finishedProductId
?:
string
;
description
:
string
;
quantity
:
number
;
unitPrice
:
number
;
totalPrice
:
number
;
taxId
?:
string
;
taxRate
:
number
;
taxAmount
:
number
;
deliveredQuantity
:
number
;
remainingQuantity
:
number
;
notes
?:
string
;
sequence
:
number
;
clientProductCode
?:
string
;
requestedDepartureDate
?:
string
;
confirmedDepartureDate
?:
string
;
unitOfMeasureId
?:
string
;
unitOfPriceId
?:
string
;
salesMultiple
?:
number
;
minimumQuantity
?:
number
;
}
[]
;
}
,
unknown
,
>
;
update
:
UseMutationResult
<
any
,
Error
,
{
id
:
string
;
number
?:
string
;
clientId
?:
string
;
clientOrderNumber
?:
string
;
orderDate
?:
string
;
requestedDepartureDate
?:
string
;
confirmedDepartureDate
?:
string
;
status
?:
|
"DRAFT"
|
"CANCELLED"
|
"COMPLETED"
|
"CONFIRMED"
|
"PENDING_CONFIRMATION"
|
"IN_PRODUCTION"
|
"READY_TO_SHIP"
|
"SHIPPED"
|
"DELIVERED"
|
"PARTIAL"
;
totalAmount
?:
number
;
currencyId
?:
string
;
salesOfferId
?:
string
;
transportDelay
?:
number
;
notes
?:
string
;
lines
?:
{
id
?:
string
;
finishedProductId
?:
string
;
description
?:
string
;
quantity
?:
number
;
unitPrice
?:
number
;
totalPrice
?:
number
;
taxId
?:
string
;
taxRate
?:
number
;
taxAmount
?:
number
;
deliveredQuantity
?:
number
;
remainingQuantity
?:
number
;
notes
?:
string
;
sequence
?:
number
;
clientProductCode
?:
string
;
requestedDepartureDate
?:
string
;
confirmedDepartureDate
?:
string
;
unitOfMeasureId
?:
string
;
unitOfPriceId
?:
string
;
salesMultiple
?:
number
;
minimumQuantity
?:
number
;
}
[]
;
}
,
unknown
,
>
;
delete
:
UseMutationResult
<
any
,
Error
,
string
,
unknown
>
;
updateStatus
:
UseMutationResult
<
any
,
Error
,
{
orderId
:
string
;
status
:
string
}
,
unknown
,
>
;
}
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
Storybook
GitHub
ETASCOM CRM V3 - Documentation API
Loading...