Add a new invoice in main table
post
/service/v1/invoice
This endpoint is used to add a new invoice.
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
-
appId(required): string
appId
-
branchCode(required): string
branchCode
-
userId(required): string
user id for SMS
Request Body that contains data required for creating a new Invoices.
Nested Schema : paging
Type:
objectNested Schema : InvoiceModel
Type:
objectInvoice model
Show Source
-
acceptanceAmount:
number
Acceptance Amount
-
action:
string
-
adjustmentReason:
string
-
allowBackDatedDisbursments:
string
-
amount:
number
Amount
-
amountToBeFinanced:
number
-
appliedDiscountAmt:
number
Applied Discount Amount
-
assignableAmount:
number
-
assignmentAmount:
number
Assignment Amount
-
assignmentParty:
string
-
bank:
string
-
branch:
string
-
bunchIdentifier:
string
-
buyerCode:
string
-
buyerDivCode:
string
Buyer Division Code
-
buyerDivName:
string
Buyer Division Name
-
buyerId:
string
Buyer Id
-
buyerName:
string
Buyer Name
-
channel:
string
Channel
-
corporateId:
string
CorporateId
-
countryOfOrigin:
string
-
creditCoverAmount:
number
Credit Cover Amount
-
currency:
string
Currency
-
discount1Days:
integer
Discount 1 Days
-
discount1Perc:
number
Discount 1 Perc
-
discount2Days:
integer
Discount 2 Days
-
discount2Perc:
number
Discount 2 Perc
-
discountAllowed:
string
-
discountAmount:
number
-
discountPercentage:
number
-
discountType:
string
-
discrepancyCode:
string
Discrepancy Code
-
disputeAction:
number
Dispute Action
-
disputedAmount:
number
-
disputeResolveRemarks:
string
Dispute Resolve Remarks
-
divisionCode:
string
-
editedFields:
array editedFields
editedFields
-
expiresOn:
string
-
exportFactorId:
string
Export Factor Id
-
exportFactorName:
string
Export Factor Id
-
feedSerialNo:
integer(int32)
-
fileName:
string
File Name
-
fileRef:
string
File Reference
-
filler1:
string
Filler1
-
filler10:
string
Filler10
-
filler2:
string
Filler2
-
filler3:
string
Filler3
-
filler4:
string
Filler4
-
filler5:
string
Filler5
-
filler6:
string
Filler6
-
filler7:
string
Filler7
-
filler8:
string
Filler8
-
filler9:
string
Filler9
-
financeableAmount:
number
-
financeAmount:
number
Finance Amount
-
financeOutstandingAmount:
number
Outstanding Amount
-
financePercentage:
number
Finance Percentage
-
financeStatus:
string
Finance Status
-
finEligibilityAmt:
number
-
finSeqNo:
number
Finance Sequence Number
-
finTxnStatus:
string
-
fundingReqAmt:
number
-
fundingReqDate:
string
-
id:
string
-
importFactorId:
string
-
importFactorName:
string
-
indicator:
string
Indicator
-
insuranceCoId:
string
-
insuranceCoName:
string
-
interestBearingPartyRole:
string
Interest bearing party role
-
invAcceptanceDate:
string
Invoice Acceptance Date
-
invoiceCommodityGridList:
array invoiceCommodityGridList
-
invoiceDate:
string
Pattern:
([0-9]{4})-([0-9]{2})-([0-9]{2})Invoice Date -
invoiceDueDate:
string
Pattern:
([0-9]{4})-([0-9]{2})-([0-9]{2})Invoice Due Date -
invoiceId:
string
Id of the Invoice
-
invoiceLinkedPoModelList:
array invoiceLinkedPoModelList
-
invoiceNumber:
string
Minimum Length:
1Maximum Length:25Invoice Number -
invoiceOfferList:
array invoiceOfferList
-
invoiceProcessStatus:
string
Invoice Process Status
-
invoiceRefNo:
string
Invoice Reference Number
-
invoiceStatus:
string
Invoice Status
-
invoiceStatusOther:
string
Invoice Status Other
-
invoiceValueDate:
string
Pattern:
([0-9]{4})-([0-9]{2})-([0-9]{2})Invoice Value Date -
isAccepted:
string
-
isApproved:
string
-
isAssigned:
string
-
isAutoAuth:
string
-
isDisputed:
string
Is Disputed
-
isDisputeResolvedWriteOff:
string
-
isFinanced:
string
-
isIndirectPayment:
string
-
isNettingFlag:
string
Neeting Flag to indicate whether netting transaction is on going, Y indicates on going netting transaction
-
isOverdue:
string
-
isPUA:
string
-
isUnderlyingPoFinanced:
string
Is Underlying PO Financed
-
jsonString:
string
-
linkedDocs:
string
-
linkedInvoiceList:
array linkedInvoiceList
-
linkInvoiceNumber:
string
Coma/Pipe seperated invoice numbers
-
makerDtStamp:
string
-
makerId:
string
-
maxAssignmentPct:
number
Maximum Assignment Percentage
-
maxFinancePercentage:
number
Maximum Finance Percentage
-
messageRefId:
string
Message Reference Id
-
minAssignableAmount:
number
Minimum Assignable Amount
-
minAssignmentPct:
number
Minimum Assignment Percentage
-
minFinanceableAmount:
number
-
miscCharge1:
number
-
miscCharge1Amount:
number
-
miscCharge1Desc:
string
-
miscCharge2:
number
-
miscCharge2Amount:
number
-
miscCharge2Desc:
string
-
netInvoiceAmount:
number
-
nettingStatus:
string
Netting Status
-
nettingTxnPayableStatus:
string
Netting Txn Payable Status
-
nettingTxnReceivableStatus:
string
Netting Txn Receivable Status
-
newFundingReqDate:
string
-
notifyingParty:
string
Notifying Party
-
oldAcceptanceAmount:
number
-
oldAssignmentAmount:
number
-
oldDisputeAmount:
number
-
oldExpiryDate:
string
-
oldFinanceAmount:
number
-
oldInvoiceDueDate:
string
-
outstandingAmount:
number
-
paidAmount:
number
Paid Amount
-
paymentCondition:
integer
Payment Condition
-
paymentDate:
string
-
paymentDueDate:
string
Payment Due Date
-
paymentMode:
string
-
paymentParty:
string
-
paymentStatus:
string
Payment Status
-
paymentTerms:
string
-
paymentThreshold:
string
Payment Threshold
-
paySeqNo:
number
Payment Sequence Number
-
poNumber:
string
Po Number
-
preAccepted:
string
-
processingBranchCode:
string
-
processingDate:
string
-
programCode:
string
Program Code
-
programName:
string
-
purchaseOrderDate:
string
-
raisedBy:
string
-
reasonCode:
string
Reason Code
-
reasonErrorCode:
string
-
reasonForExport:
string
-
reasonForShipment:
string
-
reconPmtAmount:
number
-
reconPmtAmountCcy:
string
-
reconTxnStatus:
string
-
relationCode:
string
Relation Code
-
remarks:
string
Remarks
-
repayAccountNo:
string
-
routingCode:
string
-
seqNo:
integer(int64)
-
shipmentAddress:
string
-
shipmentCity:
string
Destination City
-
shipmentCountry:
string
-
shipmentDate:
string
-
shipmentNo:
string
-
shipmentPhoneNumber:
string
Contact Number of Addressee
-
shipmentRefNo:
string
-
shipmentTaxId:
string
Tax ID
-
shipmentZipCode:
string
Destination Zip Code
-
shipSeqNo:
number
Shipment Sequence Number
-
sourceTxnId:
string
-
srcAppCd:
string
Source Application Code
-
srcAppCdStr:
string
Source Application Code String
-
stageId:
string
-
staleStatus:
string
-
supplierCode:
string
-
supplierDivCode:
string
Supplier Division Code
-
supplierDivName:
string
Supplier Division Name
-
supplierId:
string
Supplier Id
-
supplierName:
string
Supplier Name
-
taxAmount:
number
Tax Amount
-
taxPercentage:
number
-
tcmId:
string
-
termsOfSale:
string
-
tmDrCrNoteLinkInvoiceList:
array tmDrCrNoteLinkInvoiceList
-
totalInvoiceAmount:
number
Total Invoice Amount
-
transactionRefNo:
string
-
useEarmarkedLimits:
string
-
validateForOverdue:
string
Whether validation for Overdue required or not
-
varianceAmount:
number
-
virtualAcFlag:
string
Nested Schema : tmDrCrNoteLinkInvoiceList
Type:
Show Source
array-
Array of:
object TmDrCrNoteLinkInvoiceModel
Model for TmDrCrNoteLinkInvoice
Nested Schema : InvoiceCommodityGridModel
Type:
Show Source
object-
ccy:
string
-
commodityCode:
string
Commodity Code
-
commodityDesc:
string
-
commodityName:
string
-
costPerUnit:
number
Cost Per unit
-
costPerUnitInInvCcy:
number
Cost Per unit In Invoice currency
-
descriptionOfGoods:
string
-
discountAmount:
number
-
discountAmountInInvCcy:
number
Discount Amount In Invoice currency
-
discountPercentage:
number
-
id:
string
-
invoiceCommodityGridId:
string
Read Only:
trueId of the Invoice Commodity Grid -
invoiceMasterId:
string
Invoice Master Id
-
invoiceNumber:
string
Invoice Number
-
invoiceRefNo:
string
Invoice Reference Number
-
isInherited:
string
-
netCost:
number
Net Cost
-
netCostInInvCcy:
number
Net Cost In Invoice currency
-
poExternalNumber:
string
-
poInternalNumber:
string
-
quantity:
number
Quantity
-
seqNo:
integer(int64)
-
taxAmount:
number
Tax Amount
-
taxAmountInInvCcy:
number
Tax Amount In Invoice currency
-
taxPercentage:
number
-
totalCost:
number
Total Cost
-
totalCostInInvCcy:
number
Total Cost In Invoice currency
-
totalWeight:
number
-
transactionRefNo:
string
-
unit:
string
-
unitWeight:
number
Nested Schema : InvoiceLinkedPoModel
Type:
Show Source
object-
buyerId:
string
-
currency:
string
-
exchangeRate:
number
-
id:
string
-
invCcy:
string
-
invoiceAllocAmount:
number
-
invoiceAllocAmountToBe:
number
-
invoiceAllocAmtInInvCcy:
number
-
invoiceAllocPercentage:
number
-
invoiceMasterId:
string
-
invoiceNumber:
string
-
invoiceRefNo:
string
-
isLinkageSuccessful:
string
-
netPoAmount:
number
-
poAvailableAmount:
number
-
poAvailableAmountPostLink:
number
-
poCcy:
string
-
poDate:
string
-
poExternalNumber:
string
-
poInternalNumber:
string
-
poStatus:
string
-
seqNo:
integer(int64)
Nested Schema : InvoiceOfferDTO
Type:
Show Source
object-
applicabilityBasis:
string
Applicability Basis
-
chgPriceTemplateId:
string
Charge Price Template Id
-
currency:
string
Currency
-
discountAmount:
number
Discount Amount
-
discountOfferActiveStatus:
string
Discount Offer Active Status
-
discountOfferStatus:
string
Discount Offer Status
-
discountPercentage:
number
Discount Percentage
-
discountRuleDesc:
string
Discount Rule Desc
-
discountRuleId:
string
Discount Rule Id
-
earlyPaymentDate:
string
Early Payment Date
-
id:
string
Id
-
invoiceMasterId:
string
Invoice Master id
-
invoiceOfferAction:
string
Invoice Offer Action
-
invoiceOfferTenorParameterList:
array invoiceOfferTenorParameterList
-
invoiceRefNo:
string
Invoice Reference No
-
isDiscOfferAccepted:
string
Is Discount Offer Accepted
-
notionalEarlyPayAmt:
number
Notional Early Pay Amount
-
requestorPartyId:
string
Requestor Party Id
-
requestorPartyRole:
string
Requestor Party Role
-
seqNo:
integer(int64)
Sequence Number
-
slidingScaleApplicable:
string
Sliding Scale Applicable
-
transactionRefNo:
string
Transaction Reference No
Nested Schema : InvoiceOfferTenorParameterModel
Type:
Show Source
object-
currency:
string
-
daysElapsedFrom:
number
-
daysElapsedTo:
number
-
discountPercentage:
number
-
discountRuleDescription:
string
-
discountRuleId:
string
-
discountTenorAmount:
number
discount tenor amount
-
invoiceMasterId:
string
-
invoiceOfferTenorParametersScheduleList:
array invoiceOfferTenorParametersScheduleList
-
invoiceRefNo:
string
Invoice Reference Number
-
isTenorSelected:
string
-
lowerDiscountRateThreshold:
number
-
paymentDateFrom:
string
-
paymentDateTo:
string
-
slidingScaleApplicableTenor:
string
-
transactionRefNo:
string
-
upperDiscountRateThreshold:
number
Nested Schema : LinkedInvoiceModel
Type:
Show Source
object-
currency:
string
currency
-
invoiceAmount:
number
invoiceAmount
-
invoiceDate:
string
invoiceDate
-
invoiceDueDate:
string
invoiceDueDate
-
invoiceNumber:
string
invoiceNumber
-
invoiceRefNo:
string
invoiceRefNo
-
invoiceStatus:
string
invoiceStatus
-
miscCharge1Amount:
number
miscCharge1Amount
-
miscCharge2Amount:
number
miscCharge2Amount
-
paymentStatus:
string
paymentStatus
Nested Schema : TmDrCrNoteLinkInvoiceModel
Type:
objectModel for TmDrCrNoteLinkInvoice
Show Source
-
dcLinkId:
string
Debit Credit Link Id
-
invoiceNumber:
string
Invoice Number
-
isDnCn:
string
Is DnCn
-
noteNumber:
string
Note Number
-
seqNo:
integer(int64)
Sequence number
-
status:
string
status
-
transactionRefNo:
string
Transaction Reference Number
Response
Supported Media Types
- application/json
- application/xml
200 Response
Returns the collection of the newly created invoices
Root Schema : CreateInvoiceResponseCollection
Type:
objectList of Create Invoice Service Response
Show Source
Nested Schema : Error
Type:
objectError Model
Show Source
-
errorCode:
string
Error Code
-
errorDescription:
string
Error Description
-
errorStatus:
string
Error Status
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