Skip to navigation

Create PO Invoice

View as Markdown

Request Body

The request should include the following parameters in the raw request body:

ParamRequiredTypeDescription
po_noMandatoryStringPurchase order number
grn_noOptionalString(Goods Receipt Note number), a unique identifier for the GRN, though it is not marked as required in this context.
requestMandatoryObjectContains details of the purchase request
request.vendorMandatoryObjectVendor details
request.vendor.codeMandatoryStringUnique code for the vendor
request.vendor.idoptionalLongVendor identification number(vendor id is mandatory if code is not present)
request.vendor.nameMandatoryStringName of the vendor
request.vendorInvoiceNumberMandatoryStringInvoice number provided by the vendor
request.billDateMandatoryLongDate of the bill in Unix timestamp format
request.categoryMandatoryObjectCategory information
request.category.idoptionalLongCategory identification number (Category id is mandatory if label is not present)
request.category.labelMandatoryStringLabel of the category
request.billToMandatoryObjectBilling details
request.billTo.nameMandatoryStringName of the entity to be billed
request.billTo.idoptionalLongBilling entity identification number
(bill to id is mandatory if name is not present)
request.shipToMandatoryObjectShipping details
request.shipTo.nameMandatoryStringName of the entity to receive the shipment
request.shipTo.idoptionalLongShipping entity identification number
(ship to id is mandatory if name is not present)
request.roundOffAmountoptionalDoubleAmount rounded off
request.itemsMandatoryObjectList of items included in the request
request.items[].baseMandatoryDoubleBase price of the item
request.items[].productMandatoryObjectProduct details
request.items[].product.codeMandatoryStringUnique code for the product
request.items[].product.idOptionalLongProduct identification number(product id is mandatory if code is not present)
request.items[].product.itemReferenceNoMandatoryStringReference number for the product
request.items[].qttyMandatoryDoubleQuantity of the product
request.items[].notesOptionalStringAdditional notes about the item
request.items[].taxSlabOptionalDoubleTax percentage applicable to the item
request.items[].serviceMandatoryObjectService details related to the item
request.items[].service.labelMandatoryStringLabel of the service
request.items[].service.valueMandatoryLongCost of the service
request.items[].taxMandatoryDoubleTotal tax amount for the item (tax is Mandatory if taxslab is present)

Upon successful execution, the API will return a status code of 200 and a JSON response with a success key indicating whether the invoice submission was successful.

Example Response

{
"invoiceId": "VI-KARANDEVENV-000000493",
"message": "Invoice Posted Successfully.",
"success": true
}

Headers

DICE-APP-IDstringOptional
X-CLIENT-IDstringOptional
X-CLIENT-SECRETstringOptional

Request

This endpoint expects an object.
po_nostringRequired
requestobjectRequired

Response headers

request-idstringOptional

Response

OK
invoiceIdstring
messagestring
successboolean