The Credit Note API is used to post a credit note for a seller-accepted return or an RTO, marking it as "invoiced."
Request Type:
POST
Scheme:HTTPS
Endpoint:https://{{host}}/oms/v3/shipment/invoiceUpdate
Try out Fynd Konnect's Credit Note Endpoint
Common Request Header
| Header | Mandatory | Description |
|---|---|---|
x-access-token | Yes | The token required for authenticated calls to Fynd Konnect. |
Shipment Id of the order to be invoiced
Unique invoice reference number
Type of invoice (Either sale for the forward order invoice series or return for the customer return credit note)
QR code data for the invoice
Invoice Reference Number for e-invoicing
Digitally signed invoice data
Acknowledgment number from tax authority
Date of acknowledgment receipt
List of items included in the invoice
Meta data for packaging if applicable; overwrites the existing package dimensions
Number of payloads in the request
Number of successfully processed payloads
Number of payloads that failed
Status of the API call
Empty if everything succeeded
- Fynd Konnect [Sandbox]https://fyndkonnect.konnect.uat.fyndx1.de/oms/v3/shipment/invoiceUpdate
curl -i -X POST \
https://fyndkonnect.konnect.uat.fyndx1.de/oms/v3/shipment/invoiceUpdate \
-H 'Content-Type: application/json' \
-H 'x-access-token: YOUR_API_KEY_HERE' \
-d '[
{
"orderId": "string",
"invoiceNumber": "string",
"invoiceType": "string",
"invoiceQrCode": "string",
"irnNumber": "string",
"signedInvoice": "string",
"ackNumber": "string",
"ackDate": "string",
"orderItems": [
{
"orderItemId": "string",
"quantity": 0,
"imeiSerialNumber": [
"string"
]
}
],
"packages": [
{
"packageId": "string",
"packageLengthCm": 0,
"packageWidthCm": 0,
"packageHeightCm": 0,
"packageWeightGms": 0
}
]
}
]'- Supports invoice updates for up to 20 orders in one call.
- Transitions orders to
credit_note_generatedon Fynd OMS after successful reverse-invoicing. - A credit note can only be pushed against a return if it is in either the
return_bag_acceptedorrto_bag_acceptedstate on Fynd. To fetch returns in this state, use Fetch Returns withorderStatus=RETURN_COMPLETED.