Update the existing invoices
patch
/service/v1/mainInvoice
This endpoint is used to update the existing invoices.
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
-
appId: string
appId
-
branchCode: string
branchCode
-
userId: string
userId
Request Body that contains invoiceList required for updating an existing Invoices
Nested Schema : paging
Type:
objectNested Schema : InvoiceModel
Type:
objectInvoice model
Show Source
-
acceptanceAmount(optional):
number
Acceptance Amount
-
action(optional):
string
-
adjustmentReason(optional):
string
-
amount(optional):
number
Amount
-
amountToBeFinanced(optional):
number
-
assignmentParty(optional):
string
-
bank(optional):
string
-
branch(optional):
string
-
bunchIdentifier(optional):
string
-
buyerCode(optional):
string
-
buyerDivCode(optional):
string
Buyer Division Code
-
buyerDivName(optional):
string
Buyer Division Name
-
buyerId(optional):
string
Buyer Id
-
buyerName(optional):
string
Buyer Name
-
channel(optional):
string
Channel
-
corporateId(optional):
string
CorporateId
-
countryOfOrigin(optional):
string
-
currency(optional):
string
Currency
-
discount1Days(optional):
integer
Discount 1 Days
-
discount1Perc(optional):
number
Discount 1 Perc
-
discount2Days(optional):
integer
Discount 2 Days
-
discount2Perc(optional):
number
Discount 2 Perc
-
discountAllowed(optional):
string
-
discountAmount(optional):
number
-
discountPercentage(optional):
number
-
discountType(optional):
string
-
discrepancyCode(optional):
string
Discrepancy Code
-
disputedAmount(optional):
number
-
disputeResolveRemarks(optional):
string
Dispute Resolve Remarks
-
divisionCode(optional):
string
-
expiresOn(optional):
string
-
exportFactorId(optional):
string
Export Factor Id
-
feedSerialNo(optional):
integer(int32)
-
fileName(optional):
string
File Name
-
fileRef(optional):
string
File Reference
-
filler1(optional):
string
Filler1
-
filler10(optional):
string
Filler10
-
filler2(optional):
string
Filler2
-
filler3(optional):
string
Filler3
-
filler4(optional):
string
Filler4
-
filler5(optional):
string
Filler5
-
filler6(optional):
string
Filler6
-
filler7(optional):
string
Filler7
-
filler8(optional):
string
Filler8
-
filler9(optional):
string
Filler9
-
financeableAmount(optional):
number
-
financeAmount(optional):
number
Finance Amount
-
financeOutstandingAmount(optional):
number
Outstanding Amount
-
financePercentage(optional):
number
Finance Percentage
-
financeStatus(optional):
string
Finance Status
-
finEligibilityAmt(optional):
number
-
finSeqNo(optional):
number
Finance Sequence Number
-
finTxnStatus(optional):
string
-
fundingReqAmt(optional):
number
-
fundingReqDate(optional):
string
-
id(optional):
string
-
importFactorId(optional):
string
-
importFactorName(optional):
string
-
indicator(optional):
string
Indicator
-
insuranceCoId(optional):
string
-
insuranceCoName(optional):
string
-
interestBearingPartyRole(optional):
string
Interest bearing party role
-
invAcceptanceDate(optional):
string
Invoice Acceptance Date
-
invoiceCommodityGridList(optional):
array invoiceCommodityGridList
-
invoiceDate(optional):
string
Invoice Date
-
invoiceDueDate(optional):
string
Invoice Due Date
-
invoiceId(optional):
string
Id of the Invoice
-
invoiceNumber(optional):
string
Invoice Number
-
invoiceOfferList(optional):
array invoiceOfferList
-
invoiceOfferTenorParameterList(optional):
array invoiceOfferTenorParameterList
-
invoiceProcessStatus(optional):
string
Invoice Process Status
-
invoiceRefNo(optional):
string
Invoice Reference Number
-
invoiceStatus(optional):
string
Invoice Status
-
invoiceValueDate(optional):
string
Invoice Value Date
-
isAccepted(optional):
string
-
isApproved(optional):
string
-
isAssigned(optional):
string
-
isAutoAuth(optional):
string
-
isDisputed(optional):
string
Is Disputed
-
isDisputeResolvedWriteOff(optional):
string
-
isFinanced(optional):
string
-
isIndirectPayment(optional):
string
-
isNettingFlag(optional):
string
Neeting Flag to indicate whether netting transaction is on going, Y indicates on going netting transaction
-
isOverdue(optional):
string
-
isPUA(optional):
string
-
linkedDocs(optional):
string
-
linkedInvoiceList(optional):
array linkedInvoiceList
-
linkInvoiceNumber(optional):
string
Coma/Pipe seperated invoice numbers
-
makerDtStamp(optional):
string
-
makerId(optional):
string
-
maxFinancePercentage(optional):
number
Maximum Finance Percentage
-
miscCharge1(optional):
number
-
miscCharge1Amount(optional):
number
-
miscCharge1Desc(optional):
string
-
miscCharge2(optional):
number
-
miscCharge2Amount(optional):
number
-
miscCharge2Desc(optional):
string
-
netInvoiceAmount(optional):
number
-
newFundingReqDate(optional):
string
-
oldAcceptanceAmount(optional):
number
-
oldDisputeAmount(optional):
number
-
oldExpiryDate(optional):
string
-
oldFinanceAmount(optional):
number
-
oldInvoiceDueDate(optional):
string
-
outstandingAmount(optional):
number
-
paidAmount(optional):
number
Paid Amount
-
paymentCondition(optional):
integer
Payment Condition
-
paymentDate(optional):
string
-
paymentDueDate(optional):
string
Payment Due Date
-
paymentMode(optional):
string
-
paymentParty(optional):
string
-
paymentStatus(optional):
string
Payment Status
-
paymentTerms(optional):
string
-
paySeqNo(optional):
number
Payment Sequence Number
-
poNumber(optional):
string
Po Number
-
preAccepted(optional):
string
-
processingBranchCode(optional):
string
-
processingDate(optional):
string
-
programCode(optional):
string
Program Code
-
programName(optional):
string
-
purchaseOrderDate(optional):
string
-
raisedBy(optional):
string
-
reasonCode(optional):
string
Reason Code
-
reasonErrorCode(optional):
string
-
reasonForExport(optional):
string
-
reasonForShipment(optional):
string
-
reconPmtAmount(optional):
number
-
reconPmtAmountCcy(optional):
string
-
reconTxnStatus(optional):
string
-
relationCode(optional):
string
Relation Code
-
remarks(optional):
string
Remarks
-
repayAccountNo(optional):
string
-
routingCode(optional):
number
-
seqNo(optional):
integer(int64)
-
shipmentAddress(optional):
string
-
shipmentCity(optional):
string
Destination City
-
shipmentCountry(optional):
string
-
shipmentDate(optional):
string
-
shipmentNo(optional):
string
-
shipmentPhoneNumber(optional):
string
Contact Number of Addressee
-
shipmentRefNo(optional):
string
-
shipmentTaxId(optional):
string
Tax ID
-
shipmentZipCode(optional):
string
Destination Zip Code
-
shipSeqNo(optional):
number
Shipment Sequence Number
-
sourceTxnId(optional):
string
-
srcAppCd(optional):
string
Source Application Code
-
stageId(optional):
string
-
staleStatus(optional):
string
-
supplierCode(optional):
string
-
supplierDivCode(optional):
string
Supplier Division Code
-
supplierDivName(optional):
string
Supplier Division Name
-
supplierId(optional):
string
Supplier Id
-
supplierName(optional):
string
Supplier Name
-
taxAmount(optional):
number
Tax Amount
-
taxPercentage(optional):
number
-
tcmId(optional):
string
-
termsOfSale(optional):
string
-
tmDrCrNoteLinkInvoiceList(optional):
array tmDrCrNoteLinkInvoiceList
-
totalInvoiceAmount(optional):
number
Total Invoice Amount
-
transactionRefNo(optional):
string
-
validateForOverdue(optional):
string
Whether validation for Overdue required or not
-
varianceAmount(optional):
number
-
virtualAcFlag(optional):
string
Nested Schema : tmDrCrNoteLinkInvoiceList
Type:
Show Source
array-
Array of:
object TmDrCrNoteLinkInvoiceModel
Model for TmDrCrNoteLinkInvoice
Nested Schema : InvoiceCommodityGridModel
Type:
Show Source
object-
ccy(optional):
string
-
commodityCode(optional):
string
Commodity Code
-
commodityDesc(optional):
string
-
commodityName(optional):
string
-
costPerUnit(optional):
number
Cost Per unit
-
descriptionOfGoods(optional):
string
-
discountAmount(optional):
number
-
discountPercentage(optional):
number
-
id(optional):
string
-
invoiceCommodityGridId(optional):
string
Read Only:
trueId of the Invoice Commodity Grid -
invoiceMasterId(optional):
string
Invoice Master Id
-
invoiceNumber(optional):
string
Invoice Number
-
invoiceRefNo(optional):
string
Invoice Reference Number
-
isInherited(optional):
string
-
netCost(optional):
number
Net Cost
-
quantity(optional):
number
Quantity
-
seqNo(optional):
integer(int64)
-
taxAmount(optional):
number
Tax Amount
-
taxPercentage(optional):
number
-
totalCost(optional):
number
Total Cost
-
totalWeight(optional):
number
-
transactionRefNo(optional):
string
-
unit(optional):
string
-
unitWeight(optional):
number
Nested Schema : InvoiceOfferDTO
Type:
Show Source
object-
applicabilityBasis(optional):
string
Applicability Basis
-
chgPriceTemplateId(optional):
string
Charge Price Template Id
-
currency(optional):
string
Currency
-
discountAmount(optional):
number
Discount Amount
-
discountOfferActiveStatus(optional):
string
Discount Offer Active Status
-
discountOfferStatus(optional):
string
Discount Offer Status
-
discountPercentage(optional):
number
Discount Percentage
-
discountRuleDesc(optional):
string
Discount Rule Desc
-
discountRuleId(optional):
string
Discount Rule Id
-
earlyPaymentDate(optional):
string
Early Payment Date
-
id(optional):
string
Id
-
invoiceMasterId(optional):
string
Invoice Master id
-
invoiceOfferAction(optional):
string
Invoice Offer Action
-
invoiceRefNo(optional):
string
Invoice Reference No
-
isDiscOfferAccepted(optional):
string
Is Discount Offer Accepted
-
notionalEarlyPayAmt(optional):
number
Notional Early Pay Amount
-
requestorPartyId(optional):
string
Requestor Party Id
-
requestorPartyRole(optional):
string
Requestor Party Role
-
seqNo(optional):
integer(int64)
Sequence Number
-
transactionRefNo(optional):
string
Transaction Reference No
Nested Schema : InvoiceOfferTenorParameterModel
Type:
Show Source
object-
currency(optional):
string
-
daysElapsedFrom(optional):
number
-
daysElapsedTo(optional):
number
-
discountPercentage(optional):
number
-
discountRuleDescription(optional):
string
-
discountRuleId(optional):
string
-
invoiceMasterId(optional):
string
-
invoiceRefNo(optional):
string
Invoice Reference Number
-
lowerDiscountRateThreshold(optional):
number
-
paymentDateFrom(optional):
string
-
paymentDateTo(optional):
string
-
slidingScaleApplicable(optional):
string
-
transactionRefNo(optional):
string
-
upperDiscountRateThreshold(optional):
number
Nested Schema : LinkedInvoiceModel
Type:
Show Source
object-
currency(optional):
string
-
invoiceAmount(optional):
number
-
invoiceDate(optional):
string
-
invoiceDueDate(optional):
string
-
invoiceNumber(optional):
string
-
invoiceRefNo(optional):
string
-
invoiceStatus(optional):
string
-
miscCharge1Amount(optional):
number
-
miscCharge2Amount(optional):
number
-
paymentStatus(optional):
string
Nested Schema : TmDrCrNoteLinkInvoiceModel
Type:
objectModel for TmDrCrNoteLinkInvoice
Show Source
-
dcLinkId(optional):
string
Debit Credit Link Id
-
invoiceNumber(optional):
string
Invoice Number
-
isDnCn(optional):
string
Is DnCn
-
noteNumber(optional):
string
Note Number
-
seqNo(optional):
integer(int64)
Sequence number
-
status(optional):
string
status
-
transactionRefNo(optional):
string
Transaction Reference Number
Response
Supported Media Types
- application/json
- application/xml
200 Response
Success
Root Schema : ResponseDtoWrapper
Type:
objectCollection of ResponseDto and ResponseResourceSupport
Show Source
-
data(optional):
object ResponseResourceSupport
Response DTO which extends RepresentationModel of Spring HATEOAS
-
messages(optional):
object ResponseDto
ResponseDto stores the response status and code.
Nested Schema : ResponseResourceSupport
Type:
objectResponse DTO which extends RepresentationModel of Spring HATEOAS
Nested Schema : ResponseDto
Type:
objectResponseDto stores the response status and code.
Show Source
Nested Schema : codes
Type:
Show Source
array-
Array of:
object ResponseCode
ResponseCode stores the response details.
Nested Schema : items
Type:
object400 Response
Bad Request
Root Schema : ResponseDtoWrapper
Type:
objectCollection of ResponseDto and ResponseResourceSupport
Show Source
-
data(optional):
object ResponseResourceSupport
Response DTO which extends RepresentationModel of Spring HATEOAS
-
messages(optional):
object ResponseDto
ResponseDto stores the response status and code.
Nested Schema : ResponseResourceSupport
Type:
objectResponse DTO which extends RepresentationModel of Spring HATEOAS
Nested Schema : ResponseDto
Type:
objectResponseDto stores the response status and code.
Show Source
Nested Schema : codes
Type:
Show Source
array-
Array of:
object ResponseCode
ResponseCode stores the response details.
Nested Schema : items
Type:
object401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
405 Response
Invalid input
500 Response
Internal error