Create Invoice

POST/api/v0/invoice/req-send-invoice

Request

device

object

required

tag

object

required

b2bIds

object

required

buyerB2BId

string

required

Match pattern:

^([^\\\"]){1,100}$

supplierB2BId

string

required

Match pattern:

^([^\\\"]){1,100}$

invoice

object

required

objectId

string

required

Unique Identifier of
the invoice across all
entities, created by
the originator.
Format:
INV<ThreadID

Match pattern:

^[INV]{3}[A-Za-z0-9]{32,32}$

supplierInvoiceNumber

string

required

Match pattern:

^([^\\\"]){1,50}$

objectVersion

object

required

string

required

Timestamp at which
invoice was created.
2017-08-
10T17:57:35+05:30

statusTransition

object

required

transactionDetails

object

required

supplierDetails

object

required

buyerDetails

object

required

dispatchDetails

object

optional

shippingDetails

object

optional

itemLists

array [object {21}]

required

valueDetails

object

optional

supplierBankAccountDetails

object

required

advancePaymentDetails

object

optional

invoiceReferenceDetails

object

optional

precedingInvoiceDetails

array [object {3}]

optional

poDetails

array [object {3}]

optional

contractReferenceDetails

array [object {6}]

optional

additionalDocumentDetails

array [object {3}]

optional

exportDetails

object

optional

ewayBillDetail

object

optional

recurringPayments

object

optional

paymentMilestones

array [object {2}]

optional

shippingTermsDetails

object

optional

invoiceFinancingDetails

object

optional

einvoiceResponse

string

optional

eInvoiceInfo

object

optional

{
  "device": {
    "tag": {
      "name": "GEOCODE",
      "value": "string"
    }
  },
  "b2bIds": {
    "buyerB2BId": "string",
    "supplierB2BId": "string"
  },
  "invoice": {
    "objectId": "string",
    "supplierInvoiceNumber": "string",
    "objectVersion": {
      "currentVersion": 1,
      "newVersion": 1
    },
    "ts": "string",
    "statusTransition": {
      "currentStatus": "CREATED",
      "newStatus": "CREATED"
    },
    "transactionDetails": {
      "taxScheme": "GST",
      "supplyType": "B2B",
      "reverseChargeTax": "YES",
      "igstChargable": "YES",
      "ecommerceGstin": "string"
    },
    "supplierDetails": {
      "b2bId": "string",
      "gstin": "string",
      "legalName": "string",
      "tradeName": "string",
      "stateCode": "string",
      "address": {
        "type": "REGISTERED ADDRESS",
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "state": "ANDAMAN AND NICOBAR ISLANDS",
        "country": "INDIA",
        "pincode": "string"
      },
      "contactNumber": {
        "type": "MOBILE",
        "countryCode": "string",
        "phoneNumber": "string"
      },
      "email": "string"
    },
    "buyerDetails": {
      "b2bId": "string",
      "gstin": "string",
      "legalName": "string",
      "tradeName": "string",
      "stateCode": "string",
      "placeOfSupply": "string",
      "address": {
        "type": "REGISTERED ADDRESS",
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "state": "ANDAMAN AND NICOBAR ISLANDS",
        "country": "INDIA",
        "pincode": "string"
      },
      "contactNumber": {
        "type": "MOBILE",
        "countryCode": "string",
        "phoneNumber": "string"
      },
      "email": "string"
    },
    "dispatchDetails": {
      "gstin": "string",
      "legalName": "string",
      "tradeName": "string",
      "stateCode": "string",
      "address": {
        "type": "REGISTERED ADDRESS",
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "state": "ANDAMAN AND NICOBAR ISLANDS",
        "country": "INDIA",
        "pincode": "string"
      },
      "contactNumber": {
        "type": "MOBILE",
        "countryCode": "string",
        "phoneNumber": "string"
      },
      "email": "string"
    },
    "shippingDetails": {
      "gstin": "string",
      "lglNm": "string",
      "trdNm": "string",
      "stateCode": "string",
      "address": {
        "type": "REGISTERED ADDRESS",
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "state": "ANDAMAN AND NICOBAR ISLANDS",
        "country": "INDIA",
        "pincode": "string"
      },
      "contactNumber": {
        "type": "MOBILE",
        "countryCode": "string",
        "phoneNumber": "string"
      },
      "email": "string"
    },
    "itemLists": [
      {
        "serialno": "string",
        "productDescription": "string",
        "isService": "YES",
        "hsnCode": "string",
        "barCode": "string",
        "quantity": 0,
        "freeQuantity": 0,
        "unit": "string",
        "unitPrice": 0,
        "totalAmt": 0,
        "assessmentAmount": 0,
        "gstRate": 0,
        "totalItemValue": 0,
        "orderLineReference": "string",
        "originCountry": "string",
        "productSerialNumber": "string",
        "itemValueDetails": [
          {
            "type": "string",
            "value": 0
          }
        ],
        "rates": [
          {
            "type": "string",
            "value": 0
          }
        ],
        "batchDetails": {
          "batchNumber": "string",
          "expiryDate": "string",
          "batchWarrantyDate": "string"
        },
        "attributeDetails": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "otherTaxes": [
          {
            "name": "string",
            "rate": 0,
            "amount": 0
          }
        ]
      }
    ],
    "valueDetails": {
      "assessmentValue": 0,
      "totalInvoiceValue": 0,
      "otherValues": [
        {
          "type": "string",
          "value": 0
        }
      ]
    },
    "supplierBankAccountDetails": {
      "maskedAccountNumber": "string",
      "ifsc": "string",
      "beneficiaryName": "string",
      "businessVPA": "string"
    },
    "advancePaymentDetails": {
      "payeeName": "string",
      "mode": "string",
      "paymentTerms": "string",
      "paymentInstruction": "string",
      "creditTransfer": "string",
      "directDebit": "string",
      "creditDays": 0,
      "paidAmount": 0,
      "pendingDueAmount": 0
    },
    "invoiceReferenceDetails": {
      "invoiceRemarks": "string",
      "invoiceStartDate": "string",
      "invoiceEndDate": "string"
    },
    "precedingInvoiceDetails": [
      {
        "invoiceNumber": "string",
        "date": "string",
        "otherReferenceNo": "string"
      }
    ],
    "poDetails": [
      {
        "poObjId": "string",
        "buyerPoId": "string",
        "poDate": "string"
      }
    ],
    "contractReferenceDetails": [
      {
        "receiptAdviceNo": "string",
        "receiptAdviceDate": "string",
        "batchReferenceNo": "string",
        "contractReferenceNo": "string",
        "extraReferenceNo": "string",
        "projectReferenceNo": "string"
      }
    ],
    "additionalDocumentDetails": [
      {
        "url": "string",
        "document": "string",
        "info": "string"
      }
    ],
    "exportDetails": {
      "shipBillNo": "string",
      "shipBillDate": "string",
      "port": "string",
      "refundClaim": "string",
      "foreignCurrency": "string",
      "countryCode": "string",
      "exportDuty": 0
    },
    "ewayBillDetail": {
      "transporterId": "string",
      "transporterName": "string",
      "transportMode": "string",
      "distance": 0,
      "transportDocumentNo": "string",
      "transportDocumentDate": "string",
      "vehicleNo": "string",
      "vehicleType": "string"
    },
    "recurringPayments": {
      "originalInvoiceId": "string",
      "frequency": "string",
      "startDate": "string",
      "endDate": "string",
      "mandateDetails": "string",
      "mandateExecutionDate": "string",
      "mandateAmount": 0
    },
    "paymentMilestones": [
      {
        "milestoneDate": "string",
        "dueAmount": 0
      }
    ],
    "shippingTermsDetails": {
      "terms": "string",
      "bearingParty": "string",
      "charges": 0
    },
    "invoiceFinancingDetails": {
      "dueAmount": 0,
      "financingRequestAmount": 0
    },
    "einvoiceResponse": "string",
    "eInvoiceInfo": {
      "schemaVersion": "string",
      "irnNumber": "string",
      "irnTs": "string"
    }
  }
}

Request samples

Responses

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

payload

string

required

response_code

integer

required

response_message

string

required

{
  "payload": "SUCCESS",
  "response_code": 0,
  "response_message": "SUCCESS"
}

Last modified: 3 months ago