Updates a invoice in main table
put
/service/v1/invoice/{invoiceRefNo}
This endpoint is used to update a main invoice.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
invoiceRefNo(required): string
invoiceRefNo for which data needs to be fetched
Header Parameters
Request Body that contains data required for updating a new Invoice.
Root Schema : InvoiceUpdateModel
Type:
objectInvoice Update model
Show Source
-
acceptanceAmount:
number
Acceptance Amount
-
assignmentAmount:
number
Assignment Amount
-
fundingReqDate:
string
Funding Request Date
-
invoiceDueDate:
string
Invoice Due Date
-
invoiceRefNo:
string
Invoice Reference Number
-
invoiceStatus:
string
Invoice Status
-
isAutoAuth:
string
Is Auto Authorized
-
newFundingReqDate:
string
New Funding Request Date
-
remarks:
string
Remarks
-
seqNo:
integer(int64)
Response
Supported Media Types
- application/json
- application/xml
200 Response
Returns the body of updated invoice
Root Schema : InvoiceModel
Invoice model
Match All
Show Source
-
object
TransactionModel
Discriminator:
model_Type -
object
InvoiceModel-allOf[1]
Nested Schema : TransactionModel
Type:
objectDiscriminator:
model_TypeNested Schema : InvoiceModel-allOf[1]
Type:
Show Source
object-
acceptanceAmount:
number
Acceptance Amount
-
action:
string
Action
-
adjustmentReason:
integer
Adjustment Reason
-
amount:
number
Amount
-
amountToBeFinanced:
number
Amount To Be Financed
-
assignmentParty:
string
Assignment Party
-
bank:
string
Bank
-
branch:
string
Branch
-
buyerCode:
string
Buyer Code
-
buyerDivCode:
string
Buyer Division Code
-
buyerDivName:
string
Buyer Division Name
-
buyerId:
string
Buyer Id
-
buyerName:
string
Buyer Name
-
countryOfOrigin:
string
Country Of Origin
-
currency:
string
Currency
-
debitNoteId:
string
Debit Note Id
-
discountAllowed:
string
Discount Allowed
-
discountAmount:
number
Discount Amount
-
discountPercentage:
number
Discount Percentage
-
discrepancyCode:
string
Discrepancy Code
-
disputedAmount:
number
Disputed Amount
-
disputeResolveRemarks:
string
Dispute Resolve Remarks
-
divisionCode:
string
Division Code
-
fileName:
string
File Name
-
fileRef:
string
File Reference
-
filler1:
string
Filler1
-
filler2:
string
Filler2
-
filler3:
string
Filler3
-
filler4:
string
Filler4
-
financeableAmount:
number
Financeable Amount
-
financeAmount:
number
Finance Amount
-
financePercentage:
number
Finance Percentage
-
finEligibilityAmt:
number
Finance Eligibility Amount
-
finTxnStatus:
string
Finance Transaction Status
-
fundingReqAmt:
number
Funding Required Amount
-
importFactorId:
string
Import Factor Id
-
importFactorName:
string
Import Factor Name
-
indicator:
string
Indicator
-
insuranceCoId:
string
Insurance Co Id
-
insuranceCoName:
string
Insurance Co Name
-
invAcceptanceDate:
string
Invoice Acceptance Date
-
invoiceCommodityGridList:
array invoiceCommodityGridList
-
invoiceDate:
string
Invoice Date
-
invoiceDueDate:
string
Invoice Due Date
-
invoiceId:
string
Id of the Invoice
-
invoiceNumber:
string
Invoice Number
-
invoiceProcessStatus:
string
Invoice Process Status
-
invoiceRefNo:
string
Invoice Reference Number
-
invoiceStatus:
string
Invoice Status
-
isAccepted:
string
Is Accepted
-
isApproved:
string
Is Approved
-
isAssigned:
string
Is Assigned
-
isAutoAuth:
string
Is Auto Authorized
-
isDebitNote:
string
Is Debit Note
-
isDisputed:
string
Is Disputed
-
isDisputeResolvedWriteOff:
string
Is Dispute Resolved Write Off
-
isFinanced:
string
Is Financed
-
isIndirectPayment:
string
Is Indirect Payment
-
isOverdue:
string
Is Overdue
-
isPUA:
string
Is PUA
-
linkedDocs:
string
Linked Documents
-
makerDtStamp:
string
Maker Date Stamp
-
makerId:
string
Maker Id
-
maxFinancePercentage:
number
Maximum Finance Percentage
-
miscCharge1:
number
Miscellaneous Charge 1
-
miscCharge1Amount:
number
Miscellaneous Charge 1 Amount
-
miscCharge1Desc:
string
Miscellaneous Charge 1 Description
-
miscCharge2:
number
Miscellaneous Charge 2
-
miscCharge2Amount:
number
Miscellaneous Charge 2 Amount
-
miscCharge2Desc:
string
Miscellaneous Charge 2 Description
-
netInvoiceAmount:
number
Net Invoice Amount
-
oldAcceptanceAmount:
number
Old Acceptance Amount
-
oldDisputeAmount:
number
Old Dispute Amount
-
oldFinanceAmount:
number
Old Finance Amount
-
oldInvoiceDueDate:
string
Old Invoice Due Date
-
outstandingAmount:
number
Outstanding Amount
-
paidAmount:
number
Paid Amount
-
paymentDate:
string
Payment date
-
paymentDueDate:
string
Payment Due Date
-
paymentMode:
string
Payment Mode
-
paymentParty:
string
Payment party
-
paymentStatus:
string
Payment Status
-
paymentTerms:
string
Payment Terms
-
poNumber:
string
PO Number
-
preAccepted:
string
Pre Accepted
-
processingBranchCode:
string
Processing Branch Code
-
processingDate:
string
Processing Date
-
programCode:
string
Program Code
-
programName:
string
Program Name
-
purchaseOrderDate:
string
Purchase Order Date
-
raisedBy:
string
Raised By
-
reasonCode:
string
Reason Code
-
reasonErrorCode:
string
Reason Error Code
-
reasonForExport:
string
Reason For Export
-
reasonForShipment:
string
Reason For Shipment
-
reconPmtAmount:
number
Recon Payment Amount
-
reconPmtAmountCcy:
string
Recon Payment Amount Currency
-
reconTxnStatus:
string
Recon Transaction Status
-
relationCode:
string
Relation Code
-
remarks:
string
Remarks
-
repayAccountNo:
string
Repay Account Number
-
routingCode:
number
Routing Code
-
seqNo:
integer(int64)
Seq of the Invoice
-
shipmentAddress:
string
Shipment Address
-
shipmentCountry:
string
Shipment Country
-
shipmentDate:
string
Shipment date
-
shipmentNo:
string
Shipment Number
-
shipmentRefNo:
string
Shipment Reference Number
-
sourceTxnId:
string
Source Transaction Id
-
srcAppCd:
string
Source Application Code
-
stageId:
string
Stage Id
-
staleStatus:
string
Stale Status
-
supplierCode:
string
Supplier Code
-
supplierDivCode:
string
Supplier Division Code
-
supplierDivName:
string
Supplier Division Name
-
supplierId:
string
Supplier Id
-
supplierName:
string
Supplier Name
-
taxAmount:
number
Tax Amount
-
taxPercentage:
number
Tax Percentage
-
tcmId:
string
Tcm Id
-
termsOfSale:
string
Terms Of Sale
-
totalInvoiceAmount:
number
Total Invoice Amount
-
transactionRefNo:
string
Transaction Reference Number
-
virtualAcFlag:
string
Virtual Account Flag
Nested Schema : InvoiceCommodityGridModel
Type:
Show Source
object-
ccy:
string
Currency
-
commodityCode:
string
Commodity Code
-
commodityDesc:
string
Commodity Description
-
commodityName:
string
Commodity Name
-
costPerUnit:
number
Cost per Unit
-
descriptionOfGoods:
string
Description Of Goods
-
discountAmount:
number
Discount Amount
-
discountPercentage:
number
Discount Percentage
-
invoiceCommodityGridId:
string
Id of the Invoice Commodity Grid
-
invoiceNumber:
string
Invoice Number
-
netCost:
number
Net Cost
-
quantity:
number
Quantity
-
taxAmount:
number
Tax Amount
-
taxPercentage:
number
Tax Percentage
-
totalCost:
number
Total Cost
-
totalWeight:
number
Total Weight
-
unit:
string
Unit
-
unitWeight:
number
Unit Weight
400 Response
Bad Request
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
405 Response
Invalid input
500 Response
Internal error