Credit Note

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.

Body

orderIdstringrequired

Shipment Id of the order to be invoiced

invoiceNumberstringrequired

Unique invoice reference number

invoiceTypestringrequired

Type of invoice (Either sale for the forward order invoice series or return for the customer return credit note)

invoiceQrCodestring

QR code data for the invoice

irnNumberstring

Invoice Reference Number for e-invoicing

signedInvoicestring

Digitally signed invoice data

ackNumberstring

Acknowledgment number from tax authority

ackDatestring

Date of acknowledgment receipt

orderItemsArray of objects

List of items included in the invoice

packagesArray of objects

Meta data for packaging if applicable; overwrites the existing package dimensions

Success Response

payloadCountinteger

Number of payloads in the request

successCountinteger

Number of successfully processed payloads

failedCountinteger

Number of payloads that failed

statusstring

Status of the API call

errorsArray of objects

Empty if everything succeeded

API Call Example

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
        }
      ]
    }
  ]'

Response

application/json

{
  "payloadCount": 2,
  "successCount": 2,
  "failedCount": 0,
  "status": "SUCCESS",
  "errors": []
}

Important Considerations

Supports invoice updates for up to 20 orders in one call.
Transitions orders to credit_note_generated on Fynd OMS after successful reverse-invoicing.
A credit note can only be pushed against a return if it is in either the return_bag_accepted or rto_bag_accepted state on Fynd. To fetch returns in this state, use Fetch Returns with orderStatus=RETURN_COMPLETED.