SimpleCreditNoteService_List

Staging

https://stg-gateway.invora.app

POST

/api/v1/simple/credit-notes/list

List credit notes with optional text search, source-invoice and
date filters, and cursor pagination. Returns lightweight summaries;
call Get for the full document.

Request

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/list' \
--header 'Content-Type: application/json' \
--data '{
    "filter": {
        "part": {
            "key": {
                "inValues": [
                    "string"
                ]
            },
            "issueAt": {
                "exact": "2019-08-24",
                "range": {
                    "fromInclusive": "2019-08-24",
                    "toExclusive": "2019-08-24"
                },
                "rangeTimestamp": {
                    "fromInclusive": "2019-08-24T14:15:22.123Z",
                    "toExclusive": "2019-08-24T14:15:22.123Z"
                }
            },
            "dueDate": {},
            "branchId": {
                "inValues": [
                    "string"
                ]
            },
            "buyerPartyKey": {
                "inValues": [
                    "string"
                ]
            },
            "currencyCode": {
                "inValues": [
                    "string"
                ]
            },
            "sourceDocumentKey": {
                "inValues": [
                    "string"
                ]
            },
            "reasonCode": {
                "inValues": [
                    "string"
                ]
            },
            "onlyFrozen": true,
            "onlyDrafts": true,
            "and": {
                "operands": [
                    {}
                ]
            },
            "or": {
                "operands": [
                    {}
                ]
            },
            "not": {}
        },
        "textSearch": "string"
    },
    "sort": {
        "rules": [
            {
                "createdAt": "SORT_DIRECTION_UNSPECIFIED",
                "issueAt": "SORT_DIRECTION_UNSPECIFIED",
                "dueDate": "SORT_DIRECTION_UNSPECIFIED",
                "payableAmount": "SORT_DIRECTION_UNSPECIFIED"
            }
        ]
    },
    "pagination": {
        "limit": "string",
        "skip": "string",
        "cursor": "string"
    },
    "mask": "string"
}'

Response Example

200 - Example 1

{
    "items": [
        {
            "key": "string",
            "sourceDocumentKey": "string",
            "issueAt": "2019-08-24T14:15:22.123Z",
            "currencyCode": "string",
            "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"
                    }
                }
            },
            "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
                }
            },
            "reasonCode": "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",
            "dueDate": "2019-08-24"
        }
    ],
    "totalCount": "string",
    "nextPageCursor": "string"
}

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

SimpleCreditNoteService_Delete

SimpleCreditNoteService_Get