# Send C/N Request

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v0/cd-note/req-send:
    post:
      summary: Send C/N Request
      deprecated: false
      description: >-

        :::highlight purple 📌

        Use this API to send a Credit Note or Debit Note (C/N) request from your
        EnKash account.

        This allows you to formally raise adjustments against invoices such as
        issuing credits for returns or applying additional charges streamlining
        your reconciliation and accounting processes.

        :::
      tags:
        - Bharat Connect (BBPS)/APIs - BBPS/Vendor Payment/Credit Note
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendCdNoteRequest'
            examples: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  payload:
                    type: string
                  response_code:
                    type: integer
                  response_message:
                    type: string
                required:
                  - payload
                  - response_code
                  - response_message
                x-apidog-orders:
                  - payload
                  - response_code
                  - response_message
                x-apidog-ignore-properties: []
              example:
                payload: SUCCESS
                response_code: 0
                response_message: SUCCESS
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Bharat Connect (BBPS)/APIs - BBPS/Vendor Payment/Credit Note
      x-apidog-status: developing
      x-run-in-apidog: https://app.apidog.com/web/project/616243/apis/api-10668100-run
components:
  schemas:
    SendCdNoteRequest:
      type: object
      properties:
        device:
          type: object
          properties:
            tag:
              type: object
              properties:
                name:
                  type: string
                  enum:
                    - GEOCODE
                    - IP
                    - AGENTID
                  x-apidog-enum:
                    - value: GEOCODE
                      name: ''
                      description: ''
                    - value: IP
                      name: ''
                      description: ''
                    - value: AGENTID
                      name: ''
                      description: ''
                value:
                  type: string
              required:
                - name
                - value
              x-apidog-orders:
                - name
                - value
              x-apidog-ignore-properties: []
          required:
            - tag
          x-apidog-orders:
            - tag
          x-apidog-ignore-properties: []
        b2bIds:
          type: object
          properties:
            buyerB2BId:
              type: string
            supplierB2BId:
              type: string
          required:
            - buyerB2BId
            - supplierB2BId
          x-apidog-orders:
            - buyerB2BId
            - supplierB2BId
          x-apidog-ignore-properties: []
        cdNote:
          type: object
          properties:
            objectId:
              type: string
            noteType:
              type: string
            supplierCDNoteNumber:
              type: string
            objectVersion:
              type: object
              properties:
                currentVersion:
                  type: integer
                newVersion:
                  type: integer
              required:
                - currentVersion
                - newVersion
              x-apidog-orders:
                - currentVersion
                - newVersion
              x-apidog-ignore-properties: []
            ts:
              type: string
            cdNoteStatusTransition:
              type: object
              properties:
                currentStatus:
                  type: string
                  enum:
                    - CREATED
                    - SENT TO BUYER
                    - ACCEPTED
                    - REJECTED
                    - UNDER REVIEW
                    - CANCELLED
                    - DELETED
                    - PARTIALLY PAID
                    - FULLY PAID
                    - CLOSED
                    - ABANDONED
                    - PAYMENT INITIATED
                    - PARTIALLY PAID AND PAYMENT INITIATED
                  x-apidog-enum:
                    - value: CREATED
                      name: ''
                      description: ''
                    - value: SENT TO BUYER
                      name: ''
                      description: ''
                    - value: ACCEPTED
                      name: ''
                      description: ''
                    - value: REJECTED
                      name: ''
                      description: ''
                    - value: UNDER REVIEW
                      name: ''
                      description: ''
                    - value: CANCELLED
                      name: ''
                      description: ''
                    - value: DELETED
                      name: ''
                      description: ''
                    - value: PARTIALLY PAID
                      name: ''
                      description: ''
                    - value: FULLY PAID
                      name: ''
                      description: ''
                    - value: CLOSED
                      name: ''
                      description: ''
                    - value: ABANDONED
                      name: ''
                      description: ''
                    - value: PAYMENT INITIATED
                      name: ''
                      description: ''
                    - value: PARTIALLY PAID AND PAYMENT INITIATED
                      name: ''
                      description: ''
                newStatus:
                  type: string
                  enum:
                    - CREATED
                    - SENT TO BUYER
                    - ACCEPTED
                    - REJECTED
                    - UNDER REVIEW
                    - CANCELLED
                    - DELETED
                    - PARTIALLY PAID
                    - FULLY PAID
                    - CLOSED
                    - ABANDONED
                    - PAYMENT INITIATED
                    - PARTIALLY PAID AND PAYMENT INITIATED
                  x-apidog-enum:
                    - value: CREATED
                      name: ''
                      description: ''
                    - value: SENT TO BUYER
                      name: ''
                      description: ''
                    - value: ACCEPTED
                      name: ''
                      description: ''
                    - value: REJECTED
                      name: ''
                      description: ''
                    - value: UNDER REVIEW
                      name: ''
                      description: ''
                    - value: CANCELLED
                      name: ''
                      description: ''
                    - value: DELETED
                      name: ''
                      description: ''
                    - value: PARTIALLY PAID
                      name: ''
                      description: ''
                    - value: FULLY PAID
                      name: ''
                      description: ''
                    - value: CLOSED
                      name: ''
                      description: ''
                    - value: ABANDONED
                      name: ''
                      description: ''
                    - value: PAYMENT INITIATED
                      name: ''
                      description: ''
                    - value: PARTIALLY PAID AND PAYMENT INITIATED
                      name: ''
                      description: ''
              required:
                - currentStatus
                - newStatus
              x-apidog-orders:
                - currentStatus
                - newStatus
              x-apidog-ignore-properties: []
            eInvoiceInfo:
              type: object
              properties:
                schemaVersion:
                  type: string
                irnNumber:
                  type: string
                irnTs:
                  type: string
              required:
                - schemaVersion
                - irnNumber
                - irnTs
              x-apidog-orders:
                - schemaVersion
                - irnNumber
                - irnTs
              x-apidog-ignore-properties: []
            transactionDetails:
              type: object
              properties:
                taxScheme:
                  type: string
                supplyType:
                  type: string
                reverseChargeTax:
                  type: string
                eCommerceGstin:
                  type: string
                igstChargable:
                  type: string
              required:
                - taxScheme
                - supplyType
                - reverseChargeTax
                - eCommerceGstin
                - igstChargable
              x-apidog-orders:
                - taxScheme
                - supplyType
                - reverseChargeTax
                - eCommerceGstin
                - igstChargable
              x-apidog-ignore-properties: []
            supplierDetails:
              type: object
              properties:
                b2bId:
                  type: string
                gstin:
                  type: string
                legalName:
                  type: string
                tradeName:
                  type: string
                stateCode:
                  type: string
                address:
                  type: object
                  properties:
                    type:
                      type: string
                    addressLine1:
                      type: string
                    addressLine2:
                      type: string
                    city:
                      type: string
                    state:
                      type: string
                    country:
                      type: string
                    pincode:
                      type: string
                  required:
                    - type
                    - addressLine1
                    - addressLine2
                    - city
                    - state
                    - country
                    - pincode
                  x-apidog-orders:
                    - type
                    - addressLine1
                    - addressLine2
                    - city
                    - state
                    - country
                    - pincode
                  x-apidog-ignore-properties: []
                contactNumber:
                  type: object
                  properties:
                    type:
                      type: string
                    countryCode:
                      type: string
                    phoneNumber:
                      type: string
                  required:
                    - type
                    - countryCode
                    - phoneNumber
                  x-apidog-orders:
                    - type
                    - countryCode
                    - phoneNumber
                  x-apidog-ignore-properties: []
                email:
                  type: string
              required:
                - b2bId
                - gstin
                - legalName
                - tradeName
                - stateCode
                - address
                - contactNumber
                - email
              x-apidog-orders:
                - b2bId
                - gstin
                - legalName
                - tradeName
                - stateCode
                - address
                - contactNumber
                - email
              x-apidog-ignore-properties: []
            buyerDetails:
              type: object
              properties:
                b2bId:
                  type: string
                gstin:
                  type: string
                legalName:
                  type: string
                tradeName:
                  type: string
                stateCode:
                  type: string
                placeOfSupply:
                  type: string
                address:
                  type: object
                  properties:
                    type:
                      type: string
                    addressLine1:
                      type: string
                    addressLine2:
                      type: string
                    city:
                      type: string
                    state:
                      type: string
                    country:
                      type: string
                    pincode:
                      type: string
                  required:
                    - type
                    - addressLine1
                    - addressLine2
                    - city
                    - state
                    - country
                    - pincode
                  x-apidog-orders:
                    - type
                    - addressLine1
                    - addressLine2
                    - city
                    - state
                    - country
                    - pincode
                  x-apidog-ignore-properties: []
                contactNumber:
                  type: object
                  properties:
                    type:
                      type: string
                    countryCode:
                      type: string
                    phoneNumber:
                      type: string
                  required:
                    - type
                    - countryCode
                    - phoneNumber
                  x-apidog-orders:
                    - type
                    - countryCode
                    - phoneNumber
                  x-apidog-ignore-properties: []
                email:
                  type: string
              required:
                - b2bId
                - gstin
                - legalName
                - tradeName
                - stateCode
                - placeOfSupply
                - address
                - contactNumber
                - email
              x-apidog-orders:
                - b2bId
                - gstin
                - legalName
                - tradeName
                - stateCode
                - placeOfSupply
                - address
                - contactNumber
                - email
              x-apidog-ignore-properties: []
            dispatchDetails:
              type: object
              properties:
                gstin:
                  type: string
                legalName:
                  type: string
                tradeName:
                  type: string
                stateCode:
                  type: string
                address:
                  type: object
                  properties:
                    type:
                      type: string
                    addressLine1:
                      type: string
                    addressLine2:
                      type: string
                    city:
                      type: string
                    state:
                      type: string
                    country:
                      type: string
                    pincode:
                      type: string
                  required:
                    - type
                    - addressLine1
                    - addressLine2
                    - city
                    - state
                    - country
                    - pincode
                  x-apidog-orders:
                    - type
                    - addressLine1
                    - addressLine2
                    - city
                    - state
                    - country
                    - pincode
                  x-apidog-ignore-properties: []
                contactNumber:
                  type: object
                  properties:
                    type:
                      type: string
                    countryCode:
                      type: string
                    phoneNumber:
                      type: string
                  required:
                    - type
                    - countryCode
                    - phoneNumber
                  x-apidog-orders:
                    - type
                    - countryCode
                    - phoneNumber
                  x-apidog-ignore-properties: []
                email:
                  type: string
              required:
                - gstin
                - legalName
                - tradeName
                - stateCode
                - address
                - contactNumber
                - email
              x-apidog-orders:
                - gstin
                - legalName
                - tradeName
                - stateCode
                - address
                - contactNumber
                - email
              x-apidog-ignore-properties: []
            shippingDetails:
              type: object
              properties:
                gstin:
                  type: string
                lglNm:
                  type: string
                trdNm:
                  type: string
                stateCode:
                  type: string
                address:
                  type: object
                  properties:
                    type:
                      type: string
                    addressLine1:
                      type: string
                    addressLine2:
                      type: string
                    city:
                      type: string
                    state:
                      type: string
                    country:
                      type: string
                    pincode:
                      type: string
                  required:
                    - type
                    - addressLine1
                    - addressLine2
                    - city
                    - state
                    - country
                    - pincode
                  x-apidog-orders:
                    - type
                    - addressLine1
                    - addressLine2
                    - city
                    - state
                    - country
                    - pincode
                  x-apidog-ignore-properties: []
                contactNumber:
                  type: object
                  properties:
                    type:
                      type: string
                    countryCode:
                      type: string
                    phoneNumber:
                      type: string
                  required:
                    - type
                    - countryCode
                    - phoneNumber
                  x-apidog-orders:
                    - type
                    - countryCode
                    - phoneNumber
                  x-apidog-ignore-properties: []
                email:
                  type: string
              required:
                - gstin
                - lglNm
                - trdNm
                - stateCode
                - address
                - contactNumber
                - email
              x-apidog-orders:
                - gstin
                - lglNm
                - trdNm
                - stateCode
                - address
                - contactNumber
                - email
              x-apidog-ignore-properties: []
            itemLists:
              type: array
              items:
                type: object
                properties:
                  serialno:
                    type: string
                  productDescription:
                    type: string
                  isService:
                    type: string
                  hsnCode:
                    type: string
                  barCode:
                    type: string
                  quantity:
                    type: number
                  freeQuantity:
                    type: number
                  unit:
                    type: string
                  unitPrice:
                    type: number
                  totalAmt:
                    type: number
                  assessmentAmount:
                    type: number
                  gstRate:
                    type: number
                  totalItemValue:
                    type: number
                  orderLineReference:
                    type: string
                  originCountry:
                    type: string
                  productSerialNumber:
                    type: string
                  itemValueDetails:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                        value:
                          type: number
                      x-apidog-orders:
                        - type
                        - value
                      x-apidog-ignore-properties: []
                  rates:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                        value:
                          type: number
                      x-apidog-orders:
                        - type
                        - value
                      x-apidog-ignore-properties: []
                  batchDetails:
                    type: object
                    properties:
                      batchNumber:
                        type: string
                      expiryDate:
                        type: string
                      batchWarrantyDate:
                        type: string
                    required:
                      - batchNumber
                      - expiryDate
                      - batchWarrantyDate
                    x-apidog-orders:
                      - batchNumber
                      - expiryDate
                      - batchWarrantyDate
                    x-apidog-ignore-properties: []
                  attributeDetails:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        value:
                          type: string
                      x-apidog-orders:
                        - name
                        - value
                      x-apidog-ignore-properties: []
                  otherTaxes:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        rate:
                          type: number
                        amount:
                          type: number
                      x-apidog-orders:
                        - name
                        - rate
                        - amount
                      x-apidog-ignore-properties: []
                x-apidog-orders:
                  - serialno
                  - productDescription
                  - isService
                  - hsnCode
                  - barCode
                  - quantity
                  - freeQuantity
                  - unit
                  - unitPrice
                  - totalAmt
                  - assessmentAmount
                  - gstRate
                  - totalItemValue
                  - orderLineReference
                  - originCountry
                  - productSerialNumber
                  - itemValueDetails
                  - rates
                  - batchDetails
                  - attributeDetails
                  - otherTaxes
                x-apidog-ignore-properties: []
            cdNoteValueDetails:
              type: object
              properties:
                assessmentValue:
                  type: number
                totalCDNoteValue:
                  type: number
                otherValues:
                  type: array
                  items:
                    type: object
                    properties:
                      type:
                        type: string
                      value:
                        type: number
                    x-apidog-orders:
                      - type
                      - value
                    x-apidog-ignore-properties: []
              required:
                - assessmentValue
                - totalCDNoteValue
                - otherValues
              x-apidog-orders:
                - assessmentValue
                - totalCDNoteValue
                - otherValues
              x-apidog-ignore-properties: []
            supplierBankAccountDetails:
              type: object
              properties:
                maskedAccountNumber:
                  type: string
                ifsc:
                  type: string
                beneficiaryName:
                  type: string
                businessVPA:
                  type: string
              required:
                - maskedAccountNumber
                - ifsc
                - beneficiaryName
                - businessVPA
              x-apidog-orders:
                - maskedAccountNumber
                - ifsc
                - beneficiaryName
                - businessVPA
              x-apidog-ignore-properties: []
            advancePaymentDetails:
              type: object
              properties:
                payeeName:
                  type: string
                mode:
                  type: string
                paymentTerms:
                  type: string
                paymentInstruction:
                  type: string
                creditTransfer:
                  type: string
                directDebit:
                  type: string
                creditDays:
                  type: integer
                paidAmount:
                  type: number
                pendingDueAmount:
                  type: number
              required:
                - payeeName
                - mode
                - paymentTerms
                - paymentInstruction
                - creditTransfer
                - directDebit
                - creditDays
                - paidAmount
                - pendingDueAmount
              x-apidog-orders:
                - payeeName
                - mode
                - paymentTerms
                - paymentInstruction
                - creditTransfer
                - directDebit
                - creditDays
                - paidAmount
                - pendingDueAmount
              x-apidog-ignore-properties: []
            invoiceReferenceDetails:
              type: object
              properties:
                invoiceRemarks:
                  type: string
                invoiceStartDate:
                  type: string
                invoiceEndDate:
                  type: string
              required:
                - invoiceRemarks
                - invoiceStartDate
                - invoiceEndDate
              x-apidog-orders:
                - invoiceRemarks
                - invoiceStartDate
                - invoiceEndDate
              x-apidog-ignore-properties: []
            precedingInvoiceDetails:
              type: array
              items:
                type: object
                properties:
                  invoiceNumber:
                    type: string
                  date:
                    type: string
                  otherReferenceNo:
                    type: string
                x-apidog-orders:
                  - invoiceNumber
                  - date
                  - otherReferenceNo
                x-apidog-ignore-properties: []
            poDetails:
              type: array
              items:
                type: object
                properties:
                  poObjId:
                    type: string
                  buyerPoId:
                    type: string
                  poDate:
                    type: string
                x-apidog-orders:
                  - poObjId
                  - buyerPoId
                  - poDate
                x-apidog-ignore-properties: []
            contractReferenceDetails:
              type: array
              items:
                type: object
                properties:
                  receiptAdviceNo:
                    type: string
                  receiptAdviceDate:
                    type: string
                  batchReferenceNo:
                    type: string
                  contractReferenceNo:
                    type: string
                  extraReferenceNo:
                    type: string
                  projectReferenceNo:
                    type: string
                x-apidog-orders:
                  - receiptAdviceNo
                  - receiptAdviceDate
                  - batchReferenceNo
                  - contractReferenceNo
                  - extraReferenceNo
                  - projectReferenceNo
                x-apidog-ignore-properties: []
            additionalDocumentDetails:
              type: array
              items:
                type: object
                properties:
                  url:
                    type: string
                  document:
                    type: string
                  info:
                    type: string
                x-apidog-orders:
                  - url
                  - document
                  - info
                x-apidog-ignore-properties: []
            exportDetails:
              type: object
              properties:
                shipBillNo:
                  type: string
                shipBillDate:
                  type: string
                port:
                  type: string
                refundClaim:
                  type: string
                foreignCurrency:
                  type: string
                countryCode:
                  type: string
                exportDuty:
                  type: number
              required:
                - shipBillNo
                - shipBillDate
                - port
                - refundClaim
                - foreignCurrency
                - countryCode
                - exportDuty
              x-apidog-orders:
                - shipBillNo
                - shipBillDate
                - port
                - refundClaim
                - foreignCurrency
                - countryCode
                - exportDuty
              x-apidog-ignore-properties: []
            ewayBillDetail:
              type: object
              properties:
                transporterId:
                  type: string
                transporterName:
                  type: string
                transportMode:
                  type: string
                distance:
                  type: integer
                transportDocumentNo:
                  type: string
                transportDocumentDate:
                  type: string
                vehicleNo:
                  type: string
                vehicleType:
                  type: string
              required:
                - transporterId
                - transporterName
                - transportMode
                - distance
                - transportDocumentNo
                - transportDocumentDate
                - vehicleNo
                - vehicleType
              x-apidog-orders:
                - transporterId
                - transporterName
                - transportMode
                - distance
                - transportDocumentNo
                - transportDocumentDate
                - vehicleNo
                - vehicleType
              x-apidog-ignore-properties: []
            recurringPayments:
              type: object
              properties:
                originalInvoiceId:
                  type: string
                frequency:
                  type: string
                startDate:
                  type: string
                endDate:
                  type: string
                mandateDetails:
                  type: string
                mandateExecutionDate:
                  type: string
                mandateAmount:
                  type: number
              required:
                - originalInvoiceId
                - frequency
                - startDate
                - endDate
                - mandateDetails
                - mandateExecutionDate
                - mandateAmount
              x-apidog-orders:
                - originalInvoiceId
                - frequency
                - startDate
                - endDate
                - mandateDetails
                - mandateExecutionDate
                - mandateAmount
              x-apidog-ignore-properties: []
            paymentMilestones:
              type: array
              items:
                type: object
                properties:
                  milestoneDate:
                    type: string
                  dueAmount:
                    type: number
                x-apidog-orders:
                  - milestoneDate
                  - dueAmount
                x-apidog-ignore-properties: []
            shippingTermsDetails:
              type: object
              properties:
                terms:
                  type: string
                bearingParty:
                  type: string
                charges:
                  type: number
              required:
                - terms
                - bearingParty
                - charges
              x-apidog-orders:
                - terms
                - bearingParty
                - charges
              x-apidog-ignore-properties: []
          required:
            - objectId
            - noteType
            - supplierCDNoteNumber
            - objectVersion
            - ts
            - cdNoteStatusTransition
            - eInvoiceInfo
            - transactionDetails
            - supplierDetails
            - buyerDetails
            - dispatchDetails
            - shippingDetails
            - itemLists
            - cdNoteValueDetails
            - supplierBankAccountDetails
            - advancePaymentDetails
            - invoiceReferenceDetails
            - precedingInvoiceDetails
            - poDetails
            - contractReferenceDetails
            - additionalDocumentDetails
            - exportDetails
            - ewayBillDetail
            - recurringPayments
            - paymentMilestones
            - shippingTermsDetails
          x-apidog-orders:
            - objectId
            - noteType
            - supplierCDNoteNumber
            - objectVersion
            - ts
            - cdNoteStatusTransition
            - eInvoiceInfo
            - transactionDetails
            - supplierDetails
            - buyerDetails
            - dispatchDetails
            - shippingDetails
            - itemLists
            - cdNoteValueDetails
            - supplierBankAccountDetails
            - advancePaymentDetails
            - invoiceReferenceDetails
            - precedingInvoiceDetails
            - poDetails
            - contractReferenceDetails
            - additionalDocumentDetails
            - exportDetails
            - ewayBillDetail
            - recurringPayments
            - paymentMilestones
            - shippingTermsDetails
          x-apidog-ignore-properties: []
        additionalInfos:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              value:
                type: string
            x-apidog-orders:
              - name
              - value
            x-apidog-ignore-properties: []
      required:
        - device
        - b2bIds
        - cdNote
        - additionalInfos
      x-apidog-orders:
        - device
        - b2bIds
        - cdNote
        - additionalInfos
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
  securitySchemes: {}
servers:
  - url: https://ekpayout-uat.enkash.in
    description: Testing Env
security: []

```