SimpleCreditNoteService_Freeze

Staging

https://stg-gateway.invora.app

POST

/api/v1/simple/credit-notes/{key}/freeze

Finalize a draft credit note and submit it to the relevant tax
authority. The response includes the QR code, signed artifact
reference, and authority status. After this call the credit note
is immutable.

Request

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Bodyapplication/json

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://stg-gateway.invora.app/api/v1/simple/credit-notes//freeze' \
--header 'Content-Type: application/json' \
--data '{
    "key": "string",
    "concurrencyStamp": "string"
}'

Response Example

200 - Example 1

{
    "details": {
        "key": "string",
        "concurrencyStamp": "string",
        "sourceDocumentKey": "string",
        "issueAt": "2019-08-24T14:15:22.123Z",
        "dueDate": "2019-08-24",
        "currencyCode": "string",
        "taxCurrencyCode": "string",
        "supplyDate": "2019-08-24",
        "supplyEndDate": "2019-08-24",
        "buyer": {
            "partyKey": "string",
            "inline": {
                "legalName": "string",
                "vatRegistrationNumber": "string",
                "additionalIds": [
                    {
                        "schemeId": "string",
                        "value": "string"
                    }
                ],
                "address": {
                    "streetName": "string",
                    "buildingNumber": "string",
                    "additionalStreetName": "string",
                    "citySubdivisionName": "string",
                    "cityName": "string",
                    "postalZone": "string",
                    "countryCode": "string"
                }
            }
        },
        "lines": [
            {
                "description": "string",
                "quantity": {
                    "value": {
                        "units": "string",
                        "nanos": 0
                    },
                    "unitCode": "string"
                },
                "unitPrice": {
                    "units": "string",
                    "nanos": 0
                },
                "tax": {
                    "taxRate": {
                        "units": "string",
                        "nanos": 0
                    },
                    "taxReasonCode": "string",
                    "taxReasonText": "string"
                },
                "sellerSku": "string",
                "buyerItemId": "string",
                "discount": {
                    "percent": {
                        "units": "string",
                        "nanos": 0
                    },
                    "amount": {
                        "units": "string",
                        "nanos": 0
                    }
                },
                "note": "string",
                "calculations": {
                    "lineExtensionAmount": {
                        "units": "string",
                        "nanos": 0
                    },
                    "discountAmount": {
                        "units": "string",
                        "nanos": 0
                    },
                    "chargeAmount": {
                        "units": "string",
                        "nanos": 0
                    },
                    "taxableAmount": {
                        "units": "string",
                        "nanos": 0
                    },
                    "taxAmount": {
                        "units": "string",
                        "nanos": 0
                    },
                    "totalAmount": {
                        "units": "string",
                        "nanos": 0
                    }
                }
            }
        ],
        "invoiceAllowances": [
            {
                "amount": {
                    "units": "string",
                    "nanos": 0
                },
                "tax": {
                    "taxRate": {
                        "units": "string",
                        "nanos": 0
                    },
                    "taxReasonCode": "string",
                    "taxReasonText": "string"
                },
                "reasonCode": "string",
                "reason": "string",
                "sequence": 0
            }
        ],
        "invoiceCharges": [
            {
                "amount": {
                    "units": "string",
                    "nanos": 0
                },
                "tax": {
                    "taxRate": {
                        "units": "string",
                        "nanos": 0
                    },
                    "taxReasonCode": "string",
                    "taxReasonText": "string"
                },
                "reasonCode": "string",
                "reason": "string",
                "sequence": 0
            }
        ],
        "reasonCode": "string",
        "reasonText": "string",
        "notes": [
            "string"
        ],
        "frozen": true,
        "audit": {
            "creationInfo": {
                "createdAt": "2019-08-24T14:15:22.123Z",
                "creatorId": "string"
            },
            "lastModificationTime": "2019-08-24T14:15:22.123Z",
            "lastModifierId": "string"
        },
        "frozenAt": "2019-08-24T14:15:22.123Z",
        "branchId": "string",
        "calculations": {
            "lineExtensionTotal": {
                "units": "string",
                "nanos": 0
            },
            "allowancesTotal": {
                "units": "string",
                "nanos": 0
            },
            "chargesTotal": {
                "units": "string",
                "nanos": 0
            },
            "taxExclusiveAmount": {
                "units": "string",
                "nanos": 0
            },
            "taxTotal": {
                "units": "string",
                "nanos": 0
            },
            "taxInclusiveAmount": {
                "units": "string",
                "nanos": 0
            },
            "payableAmount": {
                "units": "string",
                "nanos": 0
            },
            "taxTotalInTaxCurrency": {
                "units": "string",
                "nanos": 0
            },
            "taxInclusiveAmountInTaxCurrency": {
                "units": "string",
                "nanos": 0
            },
            "documentToTaxCurrencyRate": {
                "units": "string",
                "nanos": 0
            }
        }
    }
}

Modified at 2026-06-11 18:59:10

SimpleCreditNoteService_Update

SimpleDebitNoteService_Create