Issue a GST e-invoice

gst.einvoice.issue

curl --request POST \
  --url https://api.pramaan.dev/v1/outcomes/gst.einvoice.issue \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "input": {
    "connectionRef": "<string>",
    "invoice": {
      "version": "<string>",
      "transaction": {
        "taxScheme": "<string>",
        "supplyType": "<string>",
        "reverseCharge": "<string>",
        "ecommerceGstin": "<string>",
        "igstOnIntra": "<string>"
      },
      "document": {
        "type": "<string>",
        "number": "<string>",
        "date": "<string>"
      },
      "seller": {
        "gstin": "<string>",
        "legalName": "<string>",
        "addressLine1": "<string>",
        "place": "<string>",
        "postalCode": 123,
        "stateCode": "<string>",
        "tradeName": "<string>",
        "addressLine2": "<string>",
        "phone": "<string>",
        "email": "<string>"
      },
      "buyer": {
        "gstin": "<string>",
        "legalName": "<string>",
        "placeOfSupply": "<string>",
        "addressLine1": "<string>",
        "place": "<string>",
        "postalCode": 123,
        "stateCode": "<string>",
        "tradeName": "<string>",
        "addressLine2": "<string>",
        "phone": "<string>",
        "email": "<string>"
      },
      "items": [
        {
          "lineNumber": "<string>",
          "isService": "<string>",
          "hsnCode": "<string>",
          "unitPrice": 123,
          "grossAmount": 123,
          "taxableAmount": 123,
          "gstRate": 123,
          "totalAmount": 123,
          "description": "<string>",
          "barcde": "<string>",
          "bchDtls": {
            "nm": "<string>",
            "expdt": "<string>",
            "wrDt": "<string>"
          },
          "quantity": 123,
          "freeQty": 123,
          "unit": "<string>",
          "discount": 123,
          "preTaxVal": 123,
          "sgstAmt": 123,
          "igstAmt": 123,
          "cgstAmt": 123,
          "cesRt": 123,
          "cesAmt": 123,
          "cesNonAdvlAmt": 123,
          "stateCesRt": 123,
          "stateCesAmt": 123,
          "stateCesNonAdvlAmt": 123,
          "otherCharges": 123,
          "ordLineRef": "<string>",
          "orgCntry": "<string>",
          "prdSlNo": "<string>",
          "attribDtls": [
            {
              "nm": "<string>",
              "val": "<string>"
            }
          ]
        }
      ],
      "totals": {
        "taxableValue": 123,
        "invoiceValue": 123,
        "cgst": 123,
        "sgst": 123,
        "igst": 123,
        "cess": 123,
        "stateCess": 123,
        "discount": 123,
        "otherCharges": 123,
        "roundOff": 123,
        "totInvValFc": 123
      },
      "dispatch": {
        "nm": "<string>",
        "addressLine1": "<string>",
        "addressLine2": "<string>",
        "place": "<string>",
        "postalCode": 123,
        "stateCode": "<string>"
      },
      "shipping": {
        "gstin": "<string>",
        "legalName": "<string>",
        "tradeName": "<string>",
        "addressLine1": "<string>",
        "addressLine2": "<string>",
        "place": "<string>",
        "postalCode": 123,
        "stateCode": "<string>"
      },
      "payment": {
        "nm": "<string>",
        "accdet": "<string>",
        "mode": "<string>",
        "fininsbr": "<string>",
        "payterm": "<string>",
        "payinstr": "<string>",
        "crtrn": "<string>",
        "dirdr": "<string>",
        "crday": 123,
        "paidamt": 123,
        "paymtdue": 123
      },
      "references": {
        "invRm": "<string>",
        "docPerdDtls": {
          "invStDt": "<string>",
          "invEndDt": "<string>"
        },
        "precDocDtls": [
          {
            "invNo": "<string>",
            "invDt": "<string>",
            "othRefNo": "<string>"
          }
        ],
        "contrDtls": [
          {
            "recAdvRefr": "<string>",
            "recAdvDt": "<string>",
            "tendrefr": "<string>",
            "contrrefr": "<string>",
            "extrefr": "<string>",
            "projrefr": "<string>",
            "porefr": "<string>",
            "poRefDt": "<string>"
          }
        ]
      },
      "additionalDocuments": [
        {
          "url": "<string>",
          "docs": "<string>",
          "info": "<string>"
        }
      ],
      "export": {
        "shipBNo": "<string>",
        "shipBDt": "<string>",
        "port": "<string>",
        "refClm": "<string>",
        "forCur": "<string>",
        "cntCode": "<string>"
      },
      "ewaybill": {
        "transid": "<string>",
        "transname": "<string>",
        "distance": 123,
        "transdocno": "<string>",
        "transdocDt": "<string>",
        "vehno": "<string>",
        "vehtype": "<string>",
        "transMode": "<string>"
      }
    }
  },
  "options": {}
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    input: {
      connectionRef: '<string>',
      invoice: {
        version: '<string>',
        transaction: {
          taxScheme: '<string>',
          supplyType: '<string>',
          reverseCharge: '<string>',
          ecommerceGstin: '<string>',
          igstOnIntra: '<string>'
        },
        document: {type: '<string>', number: '<string>', date: '<string>'},
        seller: {
          gstin: '<string>',
          legalName: '<string>',
          addressLine1: '<string>',
          place: '<string>',
          postalCode: 123,
          stateCode: '<string>',
          tradeName: '<string>',
          addressLine2: '<string>',
          phone: '<string>',
          email: '<string>'
        },
        buyer: {
          gstin: '<string>',
          legalName: '<string>',
          placeOfSupply: '<string>',
          addressLine1: '<string>',
          place: '<string>',
          postalCode: 123,
          stateCode: '<string>',
          tradeName: '<string>',
          addressLine2: '<string>',
          phone: '<string>',
          email: '<string>'
        },
        items: [
          {
            lineNumber: '<string>',
            isService: '<string>',
            hsnCode: '<string>',
            unitPrice: 123,
            grossAmount: 123,
            taxableAmount: 123,
            gstRate: 123,
            totalAmount: 123,
            description: '<string>',
            barcde: '<string>',
            bchDtls: {nm: '<string>', expdt: '<string>', wrDt: '<string>'},
            quantity: 123,
            freeQty: 123,
            unit: '<string>',
            discount: 123,
            preTaxVal: 123,
            sgstAmt: 123,
            igstAmt: 123,
            cgstAmt: 123,
            cesRt: 123,
            cesAmt: 123,
            cesNonAdvlAmt: 123,
            stateCesRt: 123,
            stateCesAmt: 123,
            stateCesNonAdvlAmt: 123,
            otherCharges: 123,
            ordLineRef: '<string>',
            orgCntry: '<string>',
            prdSlNo: '<string>',
            attribDtls: [{nm: '<string>', val: '<string>'}]
          }
        ],
        totals: {
          taxableValue: 123,
          invoiceValue: 123,
          cgst: 123,
          sgst: 123,
          igst: 123,
          cess: 123,
          stateCess: 123,
          discount: 123,
          otherCharges: 123,
          roundOff: 123,
          totInvValFc: 123
        },
        dispatch: {
          nm: '<string>',
          addressLine1: '<string>',
          addressLine2: '<string>',
          place: '<string>',
          postalCode: 123,
          stateCode: '<string>'
        },
        shipping: {
          gstin: '<string>',
          legalName: '<string>',
          tradeName: '<string>',
          addressLine1: '<string>',
          addressLine2: '<string>',
          place: '<string>',
          postalCode: 123,
          stateCode: '<string>'
        },
        payment: {
          nm: '<string>',
          accdet: '<string>',
          mode: '<string>',
          fininsbr: '<string>',
          payterm: '<string>',
          payinstr: '<string>',
          crtrn: '<string>',
          dirdr: '<string>',
          crday: 123,
          paidamt: 123,
          paymtdue: 123
        },
        references: {
          invRm: '<string>',
          docPerdDtls: {invStDt: '<string>', invEndDt: '<string>'},
          precDocDtls: [{invNo: '<string>', invDt: '<string>', othRefNo: '<string>'}],
          contrDtls: [
            {
              recAdvRefr: '<string>',
              recAdvDt: '<string>',
              tendrefr: '<string>',
              contrrefr: '<string>',
              extrefr: '<string>',
              projrefr: '<string>',
              porefr: '<string>',
              poRefDt: '<string>'
            }
          ]
        },
        additionalDocuments: [{url: '<string>', docs: '<string>', info: '<string>'}],
        export: {
          shipBNo: '<string>',
          shipBDt: '<string>',
          port: '<string>',
          refClm: '<string>',
          forCur: '<string>',
          cntCode: '<string>'
        },
        ewaybill: {
          transid: '<string>',
          transname: '<string>',
          distance: 123,
          transdocno: '<string>',
          transdocDt: '<string>',
          vehno: '<string>',
          vehtype: '<string>',
          transMode: '<string>'
        }
      }
    },
    options: {}
  })
};

fetch('https://api.pramaan.dev/v1/outcomes/gst.einvoice.issue', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.pramaan.dev/v1/outcomes/gst.einvoice.issue"

payload = {
    "input": {
        "connectionRef": "<string>",
        "invoice": {
            "version": "<string>",
            "transaction": {
                "taxScheme": "<string>",
                "supplyType": "<string>",
                "reverseCharge": "<string>",
                "ecommerceGstin": "<string>",
                "igstOnIntra": "<string>"
            },
            "document": {
                "type": "<string>",
                "number": "<string>",
                "date": "<string>"
            },
            "seller": {
                "gstin": "<string>",
                "legalName": "<string>",
                "addressLine1": "<string>",
                "place": "<string>",
                "postalCode": 123,
                "stateCode": "<string>",
                "tradeName": "<string>",
                "addressLine2": "<string>",
                "phone": "<string>",
                "email": "<string>"
            },
            "buyer": {
                "gstin": "<string>",
                "legalName": "<string>",
                "placeOfSupply": "<string>",
                "addressLine1": "<string>",
                "place": "<string>",
                "postalCode": 123,
                "stateCode": "<string>",
                "tradeName": "<string>",
                "addressLine2": "<string>",
                "phone": "<string>",
                "email": "<string>"
            },
            "items": [
                {
                    "lineNumber": "<string>",
                    "isService": "<string>",
                    "hsnCode": "<string>",
                    "unitPrice": 123,
                    "grossAmount": 123,
                    "taxableAmount": 123,
                    "gstRate": 123,
                    "totalAmount": 123,
                    "description": "<string>",
                    "barcde": "<string>",
                    "bchDtls": {
                        "nm": "<string>",
                        "expdt": "<string>",
                        "wrDt": "<string>"
                    },
                    "quantity": 123,
                    "freeQty": 123,
                    "unit": "<string>",
                    "discount": 123,
                    "preTaxVal": 123,
                    "sgstAmt": 123,
                    "igstAmt": 123,
                    "cgstAmt": 123,
                    "cesRt": 123,
                    "cesAmt": 123,
                    "cesNonAdvlAmt": 123,
                    "stateCesRt": 123,
                    "stateCesAmt": 123,
                    "stateCesNonAdvlAmt": 123,
                    "otherCharges": 123,
                    "ordLineRef": "<string>",
                    "orgCntry": "<string>",
                    "prdSlNo": "<string>",
                    "attribDtls": [
                        {
                            "nm": "<string>",
                            "val": "<string>"
                        }
                    ]
                }
            ],
            "totals": {
                "taxableValue": 123,
                "invoiceValue": 123,
                "cgst": 123,
                "sgst": 123,
                "igst": 123,
                "cess": 123,
                "stateCess": 123,
                "discount": 123,
                "otherCharges": 123,
                "roundOff": 123,
                "totInvValFc": 123
            },
            "dispatch": {
                "nm": "<string>",
                "addressLine1": "<string>",
                "addressLine2": "<string>",
                "place": "<string>",
                "postalCode": 123,
                "stateCode": "<string>"
            },
            "shipping": {
                "gstin": "<string>",
                "legalName": "<string>",
                "tradeName": "<string>",
                "addressLine1": "<string>",
                "addressLine2": "<string>",
                "place": "<string>",
                "postalCode": 123,
                "stateCode": "<string>"
            },
            "payment": {
                "nm": "<string>",
                "accdet": "<string>",
                "mode": "<string>",
                "fininsbr": "<string>",
                "payterm": "<string>",
                "payinstr": "<string>",
                "crtrn": "<string>",
                "dirdr": "<string>",
                "crday": 123,
                "paidamt": 123,
                "paymtdue": 123
            },
            "references": {
                "invRm": "<string>",
                "docPerdDtls": {
                    "invStDt": "<string>",
                    "invEndDt": "<string>"
                },
                "precDocDtls": [
                    {
                        "invNo": "<string>",
                        "invDt": "<string>",
                        "othRefNo": "<string>"
                    }
                ],
                "contrDtls": [
                    {
                        "recAdvRefr": "<string>",
                        "recAdvDt": "<string>",
                        "tendrefr": "<string>",
                        "contrrefr": "<string>",
                        "extrefr": "<string>",
                        "projrefr": "<string>",
                        "porefr": "<string>",
                        "poRefDt": "<string>"
                    }
                ]
            },
            "additionalDocuments": [
                {
                    "url": "<string>",
                    "docs": "<string>",
                    "info": "<string>"
                }
            ],
            "export": {
                "shipBNo": "<string>",
                "shipBDt": "<string>",
                "port": "<string>",
                "refClm": "<string>",
                "forCur": "<string>",
                "cntCode": "<string>"
            },
            "ewaybill": {
                "transid": "<string>",
                "transname": "<string>",
                "distance": 123,
                "transdocno": "<string>",
                "transdocDt": "<string>",
                "vehno": "<string>",
                "vehtype": "<string>",
                "transMode": "<string>"
            }
        }
    },
    "options": {}
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "job_id": "<string>",
  "status": "running",
  "held_micro": 123
}

{
  "error": {
    "code": "addendum_required",
    "message": "<string>",
    "next": "<string>",
    "request_id": "<string>",
    "retryable": true,
    "effect": "none",
    "slot": "<string>",
    "required_micro": 123,
    "reason": "balance",
    "plan": "<string>",
    "needs": [
      {
        "kind": "approval",
        "detail": "<string>",
        "step": "<string>"
      }
    ]
  }
}

POST

outcomes

gst.einvoice.issue

curl --request POST \
  --url https://api.pramaan.dev/v1/outcomes/gst.einvoice.issue \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "input": {
    "connectionRef": "<string>",
    "invoice": {
      "version": "<string>",
      "transaction": {
        "taxScheme": "<string>",
        "supplyType": "<string>",
        "reverseCharge": "<string>",
        "ecommerceGstin": "<string>",
        "igstOnIntra": "<string>"
      },
      "document": {
        "type": "<string>",
        "number": "<string>",
        "date": "<string>"
      },
      "seller": {
        "gstin": "<string>",
        "legalName": "<string>",
        "addressLine1": "<string>",
        "place": "<string>",
        "postalCode": 123,
        "stateCode": "<string>",
        "tradeName": "<string>",
        "addressLine2": "<string>",
        "phone": "<string>",
        "email": "<string>"
      },
      "buyer": {
        "gstin": "<string>",
        "legalName": "<string>",
        "placeOfSupply": "<string>",
        "addressLine1": "<string>",
        "place": "<string>",
        "postalCode": 123,
        "stateCode": "<string>",
        "tradeName": "<string>",
        "addressLine2": "<string>",
        "phone": "<string>",
        "email": "<string>"
      },
      "items": [
        {
          "lineNumber": "<string>",
          "isService": "<string>",
          "hsnCode": "<string>",
          "unitPrice": 123,
          "grossAmount": 123,
          "taxableAmount": 123,
          "gstRate": 123,
          "totalAmount": 123,
          "description": "<string>",
          "barcde": "<string>",
          "bchDtls": {
            "nm": "<string>",
            "expdt": "<string>",
            "wrDt": "<string>"
          },
          "quantity": 123,
          "freeQty": 123,
          "unit": "<string>",
          "discount": 123,
          "preTaxVal": 123,
          "sgstAmt": 123,
          "igstAmt": 123,
          "cgstAmt": 123,
          "cesRt": 123,
          "cesAmt": 123,
          "cesNonAdvlAmt": 123,
          "stateCesRt": 123,
          "stateCesAmt": 123,
          "stateCesNonAdvlAmt": 123,
          "otherCharges": 123,
          "ordLineRef": "<string>",
          "orgCntry": "<string>",
          "prdSlNo": "<string>",
          "attribDtls": [
            {
              "nm": "<string>",
              "val": "<string>"
            }
          ]
        }
      ],
      "totals": {
        "taxableValue": 123,
        "invoiceValue": 123,
        "cgst": 123,
        "sgst": 123,
        "igst": 123,
        "cess": 123,
        "stateCess": 123,
        "discount": 123,
        "otherCharges": 123,
        "roundOff": 123,
        "totInvValFc": 123
      },
      "dispatch": {
        "nm": "<string>",
        "addressLine1": "<string>",
        "addressLine2": "<string>",
        "place": "<string>",
        "postalCode": 123,
        "stateCode": "<string>"
      },
      "shipping": {
        "gstin": "<string>",
        "legalName": "<string>",
        "tradeName": "<string>",
        "addressLine1": "<string>",
        "addressLine2": "<string>",
        "place": "<string>",
        "postalCode": 123,
        "stateCode": "<string>"
      },
      "payment": {
        "nm": "<string>",
        "accdet": "<string>",
        "mode": "<string>",
        "fininsbr": "<string>",
        "payterm": "<string>",
        "payinstr": "<string>",
        "crtrn": "<string>",
        "dirdr": "<string>",
        "crday": 123,
        "paidamt": 123,
        "paymtdue": 123
      },
      "references": {
        "invRm": "<string>",
        "docPerdDtls": {
          "invStDt": "<string>",
          "invEndDt": "<string>"
        },
        "precDocDtls": [
          {
            "invNo": "<string>",
            "invDt": "<string>",
            "othRefNo": "<string>"
          }
        ],
        "contrDtls": [
          {
            "recAdvRefr": "<string>",
            "recAdvDt": "<string>",
            "tendrefr": "<string>",
            "contrrefr": "<string>",
            "extrefr": "<string>",
            "projrefr": "<string>",
            "porefr": "<string>",
            "poRefDt": "<string>"
          }
        ]
      },
      "additionalDocuments": [
        {
          "url": "<string>",
          "docs": "<string>",
          "info": "<string>"
        }
      ],
      "export": {
        "shipBNo": "<string>",
        "shipBDt": "<string>",
        "port": "<string>",
        "refClm": "<string>",
        "forCur": "<string>",
        "cntCode": "<string>"
      },
      "ewaybill": {
        "transid": "<string>",
        "transname": "<string>",
        "distance": 123,
        "transdocno": "<string>",
        "transdocDt": "<string>",
        "vehno": "<string>",
        "vehtype": "<string>",
        "transMode": "<string>"
      }
    }
  },
  "options": {}
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    input: {
      connectionRef: '<string>',
      invoice: {
        version: '<string>',
        transaction: {
          taxScheme: '<string>',
          supplyType: '<string>',
          reverseCharge: '<string>',
          ecommerceGstin: '<string>',
          igstOnIntra: '<string>'
        },
        document: {type: '<string>', number: '<string>', date: '<string>'},
        seller: {
          gstin: '<string>',
          legalName: '<string>',
          addressLine1: '<string>',
          place: '<string>',
          postalCode: 123,
          stateCode: '<string>',
          tradeName: '<string>',
          addressLine2: '<string>',
          phone: '<string>',
          email: '<string>'
        },
        buyer: {
          gstin: '<string>',
          legalName: '<string>',
          placeOfSupply: '<string>',
          addressLine1: '<string>',
          place: '<string>',
          postalCode: 123,
          stateCode: '<string>',
          tradeName: '<string>',
          addressLine2: '<string>',
          phone: '<string>',
          email: '<string>'
        },
        items: [
          {
            lineNumber: '<string>',
            isService: '<string>',
            hsnCode: '<string>',
            unitPrice: 123,
            grossAmount: 123,
            taxableAmount: 123,
            gstRate: 123,
            totalAmount: 123,
            description: '<string>',
            barcde: '<string>',
            bchDtls: {nm: '<string>', expdt: '<string>', wrDt: '<string>'},
            quantity: 123,
            freeQty: 123,
            unit: '<string>',
            discount: 123,
            preTaxVal: 123,
            sgstAmt: 123,
            igstAmt: 123,
            cgstAmt: 123,
            cesRt: 123,
            cesAmt: 123,
            cesNonAdvlAmt: 123,
            stateCesRt: 123,
            stateCesAmt: 123,
            stateCesNonAdvlAmt: 123,
            otherCharges: 123,
            ordLineRef: '<string>',
            orgCntry: '<string>',
            prdSlNo: '<string>',
            attribDtls: [{nm: '<string>', val: '<string>'}]
          }
        ],
        totals: {
          taxableValue: 123,
          invoiceValue: 123,
          cgst: 123,
          sgst: 123,
          igst: 123,
          cess: 123,
          stateCess: 123,
          discount: 123,
          otherCharges: 123,
          roundOff: 123,
          totInvValFc: 123
        },
        dispatch: {
          nm: '<string>',
          addressLine1: '<string>',
          addressLine2: '<string>',
          place: '<string>',
          postalCode: 123,
          stateCode: '<string>'
        },
        shipping: {
          gstin: '<string>',
          legalName: '<string>',
          tradeName: '<string>',
          addressLine1: '<string>',
          addressLine2: '<string>',
          place: '<string>',
          postalCode: 123,
          stateCode: '<string>'
        },
        payment: {
          nm: '<string>',
          accdet: '<string>',
          mode: '<string>',
          fininsbr: '<string>',
          payterm: '<string>',
          payinstr: '<string>',
          crtrn: '<string>',
          dirdr: '<string>',
          crday: 123,
          paidamt: 123,
          paymtdue: 123
        },
        references: {
          invRm: '<string>',
          docPerdDtls: {invStDt: '<string>', invEndDt: '<string>'},
          precDocDtls: [{invNo: '<string>', invDt: '<string>', othRefNo: '<string>'}],
          contrDtls: [
            {
              recAdvRefr: '<string>',
              recAdvDt: '<string>',
              tendrefr: '<string>',
              contrrefr: '<string>',
              extrefr: '<string>',
              projrefr: '<string>',
              porefr: '<string>',
              poRefDt: '<string>'
            }
          ]
        },
        additionalDocuments: [{url: '<string>', docs: '<string>', info: '<string>'}],
        export: {
          shipBNo: '<string>',
          shipBDt: '<string>',
          port: '<string>',
          refClm: '<string>',
          forCur: '<string>',
          cntCode: '<string>'
        },
        ewaybill: {
          transid: '<string>',
          transname: '<string>',
          distance: 123,
          transdocno: '<string>',
          transdocDt: '<string>',
          vehno: '<string>',
          vehtype: '<string>',
          transMode: '<string>'
        }
      }
    },
    options: {}
  })
};

fetch('https://api.pramaan.dev/v1/outcomes/gst.einvoice.issue', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.pramaan.dev/v1/outcomes/gst.einvoice.issue"

payload = {
    "input": {
        "connectionRef": "<string>",
        "invoice": {
            "version": "<string>",
            "transaction": {
                "taxScheme": "<string>",
                "supplyType": "<string>",
                "reverseCharge": "<string>",
                "ecommerceGstin": "<string>",
                "igstOnIntra": "<string>"
            },
            "document": {
                "type": "<string>",
                "number": "<string>",
                "date": "<string>"
            },
            "seller": {
                "gstin": "<string>",
                "legalName": "<string>",
                "addressLine1": "<string>",
                "place": "<string>",
                "postalCode": 123,
                "stateCode": "<string>",
                "tradeName": "<string>",
                "addressLine2": "<string>",
                "phone": "<string>",
                "email": "<string>"
            },
            "buyer": {
                "gstin": "<string>",
                "legalName": "<string>",
                "placeOfSupply": "<string>",
                "addressLine1": "<string>",
                "place": "<string>",
                "postalCode": 123,
                "stateCode": "<string>",
                "tradeName": "<string>",
                "addressLine2": "<string>",
                "phone": "<string>",
                "email": "<string>"
            },
            "items": [
                {
                    "lineNumber": "<string>",
                    "isService": "<string>",
                    "hsnCode": "<string>",
                    "unitPrice": 123,
                    "grossAmount": 123,
                    "taxableAmount": 123,
                    "gstRate": 123,
                    "totalAmount": 123,
                    "description": "<string>",
                    "barcde": "<string>",
                    "bchDtls": {
                        "nm": "<string>",
                        "expdt": "<string>",
                        "wrDt": "<string>"
                    },
                    "quantity": 123,
                    "freeQty": 123,
                    "unit": "<string>",
                    "discount": 123,
                    "preTaxVal": 123,
                    "sgstAmt": 123,
                    "igstAmt": 123,
                    "cgstAmt": 123,
                    "cesRt": 123,
                    "cesAmt": 123,
                    "cesNonAdvlAmt": 123,
                    "stateCesRt": 123,
                    "stateCesAmt": 123,
                    "stateCesNonAdvlAmt": 123,
                    "otherCharges": 123,
                    "ordLineRef": "<string>",
                    "orgCntry": "<string>",
                    "prdSlNo": "<string>",
                    "attribDtls": [
                        {
                            "nm": "<string>",
                            "val": "<string>"
                        }
                    ]
                }
            ],
            "totals": {
                "taxableValue": 123,
                "invoiceValue": 123,
                "cgst": 123,
                "sgst": 123,
                "igst": 123,
                "cess": 123,
                "stateCess": 123,
                "discount": 123,
                "otherCharges": 123,
                "roundOff": 123,
                "totInvValFc": 123
            },
            "dispatch": {
                "nm": "<string>",
                "addressLine1": "<string>",
                "addressLine2": "<string>",
                "place": "<string>",
                "postalCode": 123,
                "stateCode": "<string>"
            },
            "shipping": {
                "gstin": "<string>",
                "legalName": "<string>",
                "tradeName": "<string>",
                "addressLine1": "<string>",
                "addressLine2": "<string>",
                "place": "<string>",
                "postalCode": 123,
                "stateCode": "<string>"
            },
            "payment": {
                "nm": "<string>",
                "accdet": "<string>",
                "mode": "<string>",
                "fininsbr": "<string>",
                "payterm": "<string>",
                "payinstr": "<string>",
                "crtrn": "<string>",
                "dirdr": "<string>",
                "crday": 123,
                "paidamt": 123,
                "paymtdue": 123
            },
            "references": {
                "invRm": "<string>",
                "docPerdDtls": {
                    "invStDt": "<string>",
                    "invEndDt": "<string>"
                },
                "precDocDtls": [
                    {
                        "invNo": "<string>",
                        "invDt": "<string>",
                        "othRefNo": "<string>"
                    }
                ],
                "contrDtls": [
                    {
                        "recAdvRefr": "<string>",
                        "recAdvDt": "<string>",
                        "tendrefr": "<string>",
                        "contrrefr": "<string>",
                        "extrefr": "<string>",
                        "projrefr": "<string>",
                        "porefr": "<string>",
                        "poRefDt": "<string>"
                    }
                ]
            },
            "additionalDocuments": [
                {
                    "url": "<string>",
                    "docs": "<string>",
                    "info": "<string>"
                }
            ],
            "export": {
                "shipBNo": "<string>",
                "shipBDt": "<string>",
                "port": "<string>",
                "refClm": "<string>",
                "forCur": "<string>",
                "cntCode": "<string>"
            },
            "ewaybill": {
                "transid": "<string>",
                "transname": "<string>",
                "distance": 123,
                "transdocno": "<string>",
                "transdocDt": "<string>",
                "vehno": "<string>",
                "vehtype": "<string>",
                "transMode": "<string>"
            }
        }
    },
    "options": {}
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "job_id": "<string>",
  "status": "running",
  "held_micro": 123
}

{
  "error": {
    "code": "addendum_required",
    "message": "<string>",
    "next": "<string>",
    "request_id": "<string>",
    "retryable": true,
    "effect": "none",
    "slot": "<string>",
    "required_micro": 123,
    "reason": "balance",
    "plan": "<string>",
    "needs": [
      {
        "kind": "approval",
        "detail": "<string>",
        "step": "<string>"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

API key: sk_live_…

Headers

Idempotency-Key

string

required

Required: a step of this outcome has an external effect. A retry with the same key repeats no step that already acted.

Maximum string length: 255

Pramaan-Plan

string

The plan a person approved, from the estimate. Required when a step of the plan needs approval. A request that makes a different plan (another input, option, step, price, organisation or member), or a plan more than 15 minutes old, is refused with conflict.

Body

application/json

input

object

required

Show child attributes

options

object

basis

object

Optional: your stated lawful basis. Recorded on the run, not checked and never required.

Show child attributes

Response

Run started; poll GET /v1/jobs/{id}

job_id

string

required

status

enum<string>

required

Available options:

running

held_micro

integer

required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.