Jump to

• Request
• Response

Creates a new invoice margin record

post

/service/v1/invoiceMarginCalc

This endpoint is used to create a new invoice margin record.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId: string
  appId
• branchCode: string
  branchCode
• userId: string
  user id for SMS

Body ()

Request Body that contains data required for creating a new ObInvoiceMarginCalcDTO.

Root Schema : ObInvoiceMarginCalcDTO

Type: object

Show Source

• bankCode(optional): string
  Bank code
• bankName(optional): string
  Bank name
• branchCode(optional): string
  Branch code
• buyerId: string
  Buyer Id
• buyerName: string
  Buyer Name
• id(optional): string
  Id
• intInvoiceRefNo: string
  Interest Invoice Reference Number
• intPaymentRefNo: string
  Interest Payment Reference Number
• invoiceRefNo: string
  Invoice Reference Number
• marginAmount: number
  Margin Amount
• marginCalculationDate: string(date)
  Margin Calculation Date
• marginCalculationStatus(optional): string
  Margin Calculation Status
• marginCcy: string
  Margin Currency
• marginHandling(optional): string
  Margin Handling
• marginPaymentMode(optional): string
  Margin Payment Mode
• marginProcessingDate(optional): string(date)
  Margin Processing Date
• marginProcessingStatus(optional): string
  Margin Processing Status
• marginRefNo: string
  Marin reference number
• paymentRefNo: string
  Payment reference number
• paymentValueDate(optional): string(date)
  Payment Value Date
• paymentValueMode(optional): string
  Payment Value Mode
• productCode: string
  Product Code
• programCode: string
  Program Code
• routingCode(optional): string
  Routing Code
• supplierAcNo(optional): string
  Supplier Account Number
• supplierId: string
  Supplier Id
• supplierName: string
  Supplier Name

{
    "type":"object",
    "required":[
        "marginRefNo",
        "intInvoiceRefNo",
        "intPaymentRefNo",
        "invoiceRefNo",
        "paymentRefNo",
        "marginAmount",
        "marginCcy",
        "buyerId",
        "supplierId",
        "buyerName",
        "supplierName",
        "productCode",
        "programCode",
        "marginCalculationDate"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "bankCode":{
            "type":"string",
            "description":"Bank code"
        },
        "bankName":{
            "type":"string",
            "description":"Bank name"
        },
        "branchCode":{
            "type":"string",
            "description":"Branch code"
        },
        "buyerId":{
            "type":"string",
            "description":"Buyer Id"
        },
        "buyerName":{
            "type":"string",
            "description":"Buyer Name"
        },
        "intInvoiceRefNo":{
            "type":"string",
            "description":"Interest Invoice Reference Number"
        },
        "intPaymentRefNo":{
            "type":"string",
            "description":"Interest Payment Reference Number"
        },
        "invoiceRefNo":{
            "type":"string",
            "description":"Invoice Reference Number"
        },
        "marginAmount":{
            "type":"number",
            "description":"Margin Amount"
        },
        "marginCalculationDate":{
            "type":"string",
            "format":"date",
            "description":"Margin Calculation Date"
        },
        "marginCalculationStatus":{
            "type":"string",
            "description":"Margin Calculation Status"
        },
        "marginCcy":{
            "type":"string",
            "description":"Margin Currency"
        },
        "marginHandling":{
            "type":"string",
            "description":"Margin Handling"
        },
        "marginPaymentMode":{
            "type":"string",
            "description":"Margin Payment Mode"
        },
        "marginProcessingDate":{
            "type":"string",
            "format":"date",
            "description":"Margin Processing Date"
        },
        "marginProcessingStatus":{
            "type":"string",
            "description":"Margin Processing Status"
        },
        "marginRefNo":{
            "type":"string",
            "description":"Marin reference number"
        },
        "paymentRefNo":{
            "type":"string",
            "description":"Payment reference number"
        },
        "paymentValueDate":{
            "type":"string",
            "format":"date",
            "description":"Payment Value Date"
        },
        "paymentValueMode":{
            "type":"string",
            "description":"Payment Value Mode"
        },
        "productCode":{
            "type":"string",
            "description":"Product Code"
        },
        "programCode":{
            "type":"string",
            "description":"Program Code"
        },
        "routingCode":{
            "type":"string",
            "description":"Routing Code"
        },
        "supplierAcNo":{
            "type":"string",
            "description":"Supplier Account Number"
        },
        "supplierId":{
            "type":"string",
            "description":"Supplier Id"
        },
        "supplierName":{
            "type":"string",
            "description":"Supplier Name"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns File Status

Body ()

Root Schema : schema

Type: string

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

Back to Top