OperationalNumberPresetText

Quick Links

Accounts Accounting Entries Products Customers Sales quotes Sales invoices Suppliers Purchase invoices

HTTP	Operation	Type	Object
POST	Read	Query	`operationalNumberPresetTexts filtered by id` Why?
POST	List	Query	`operationalNumberPresetTexts`

Description

Represents the Operational Number Preset Texts in the API context, used for defining numbering prefixes for different types of sales documents.
These presets provide flexibility in customizing document numbering.

The API resources / Organization Sales Setup includes two fields to define the default presets: one for invoices and another for credit notes.

How to retrieve invoice prefixes ?

graphQL Query

query {
    operationalNumberPresetTexts(
        where: {
            operation: { eq: INVOICE }
        }
    ) {
        edges {
            node {
                id
                description
                isDefault
                operation
                presetText
            }
        }
    }
}

Example Response

{
    "data": {
        "operationalNumberPresetTexts": {
            "edges": [
                {
                    "node": {
                        "id": "01234567-89ab-cdef-0123-456789abcdef",
                        "description": "Default invoice prefix",
                        "isDefault": true,
                        "operation": "INVOICE",
                        "presetText": "INV"
                    }
                }
            ]
        }
    }
}

Key	Value
`Authorization`	Bearer Current access Token How to find?
~~`X-TenantId`~~ DeprThis field is now deprecated, and we recommend using an alternative solution	Current tenant id Why deprecated ?
`X-OrganizationId`	Current organization Id How to find?
`x-api-key`	Primary or secondary subscription key of your app How to find?

operationalNumberPresetTexts

Fields	Type	Description
id SSystem field that cannot be assigned	UUID	Id
creationDate SSystem field that cannot be assigned	DateTime	Creation date
modificationDate SSystem field that cannot be assigned	DateTime	Modification date

description	String	Description of the preset text See InfoAdditional information is available in the Info block below
isDefault	Boolean	Indicates if it is the default preset See InfoAdditional information is available in the Info block below
operation	NOT_SPECIFIED DELIVERY_NOTE INVOICE ORDER QUOTE	Operation type related to the preset See InfoAdditional information is available in the Info block below
operationalNumberSeriesType COMING SOON This feature is currently in development and will be available in the next version. It’s already documented to keep you informed about its upcoming availability	NOT_SPECIFIED NORMAL RECOVERY_MANUALLY RECOVERY_IMPORTED	Operational number series type See InfoAdditional information is available in the Info block below
presetText	String	Preset text See InfoAdditional information is available in the Info block below

Info

Description:
Provides details about the operational number preset text.
Is Default:
Indicates that this preset will be the default prefix proposed when creating a document of the type specified in Operation, such as Quote, Order, Delivery Note, or Invoice.
Operation:
Specifies the type of operation associated with this preset, such as Quote, Order, Delivery Note or Invoice.
operationalNumberSeriesType:
- Unused for the French market
- Unused for the Spanish market
- Unused for the German market
- (PT content to be validated with product team)
Preset Text:
Defines the predefined text or prefix applied to operational numbers.