This feature is currently under development and, although not available in the current version, its preliminary documentation is provided to give you a preview of the enhancements that will be included in an upcoming update.

HTTP Operation Type Object
Query organizationSalesSetupByOrgId

Description

The organizationSalesSetupByOrgId operation allows developers to fetch detailed sales setup information for a specific organization. This setup includes key parameters necessary for managing sales, purchase invoices, inventory, and discount configurations effectively.

The details retrieved by this operation include:

  • Posting permissions for sales and purchase invoices
  • Discount groups and tariff IDs
  • Default journal types and session IDs for purchase and sales invoices
  • Stock, serial number, and batch number configurations
  • Valuation methods and tax group settings

img

graphQL Query
query ($id: ID!) {
    organizationSalesSetupByOrgId(id: $id) {
        salesInvoiceDefaultPresetTextId
        salesCreditNoteDefaultPresetTextId
        useSalesTracking
        useVATRatesForDOM
        allowPostingSalesInvoice
        defaultSalesPostingInvoiceJournalTypeId
        defaultSalesPostingInvoiceSessionId
        allowPostingPurchaseInvoice
        defaultPurchasePostingInvoiceJournalTypeId
        defaultPurchasePostingInvoiceSessionId
    }
}
graphQL Variables

{
    "id":"{{X-OrganizationId}}"
}

Example Response
{
    "data": {
        "organizationSalesSetupByOrgId": {
            "salesInvoiceDefaultPresetTextId": "01234567-89ab-cdef-0123-456789abcdef",
            "salesCreditNoteDefaultPresetTextId": "41234567-89ab-cdef-0123-456789abcdef",
            "useSalesTracking": true,
            "useVATRatesForDOM": false,
            "allowPostingSalesInvoice": true,
            "defaultSalesPostingInvoiceJournalTypeId": "81234567-89ab-cdef-0123-456789abcdef",
            "defaultSalesPostingInvoiceSessionId": "71234567-89ab-cdef-0123-456789abcdef",
            "allowPostingPurchaseInvoice": false,
            "defaultPurchasePostingInvoiceJournalTypeId": "a1234567-89ab-cdef-0123-456789abcdef",
            "defaultPurchasePostingInvoiceSessionId": "882f7366-8927-49c3-aa01-2162ea3d2439"
        }
    }
}
Key Value
Authorization Bearer Current access Token How to find?
X-TenantId Current tenant id How to find?
X-OrganizationId Current organization Id How to find?
x-api-key Primary or secondary subscription key of your app How to find?

organizationSalesSetupByOrgId

Fields Type Description
Sales    
salesInvoiceDefaultPresetTextId UUID ID of the default preset text for sales invoices
salesCreditNoteDefaultPresetTextId UUID ID of the default preset text for sales credit notes
useSalesTracking Boolean Indicates if sales tracking is enabled
useVATRatesForDOM Boolean Indicates if VAT rates for DOM are used
     
Posting Sales Invoices    
allowPostingSalesInvoice Boolean Allow posting sales invoices
defaultSalesPostingInvoiceJournalTypeId UUID Default journal type ID for sales invoices
defaultSalesPostingInvoiceSessionId UUID Default session ID for sales invoices
     
Posting Purchase Invoices    
allowPostingPurchaseInvoice Boolean Allow posting purchase invoices
defaultPurchasePostingInvoiceJournalTypeId UUID Default journal type ID for purchase invoices
defaultPurchasePostingInvoiceSessionId UUID Default session ID for purchase invoices
Info
  • salesInvoiceDefaultPresetTextId: Id of the Preset Text defined in Operational Number Preset Texts
  • salesCreditNoteDefaultPresetTextId: Id of the Preset Text defined in Operational Number Preset Texts
  • useVATRatesForDOM

    This allows you to select VAT rates for DOM in sales entities.

    Not used for Spanish Market

    Not used for German Market

  • defaultSalesPostingInvoiceSessionId

    Not used for French Market

    Not used for Spanish Market

    Used to define the Session preference for posting a sales invoice to your accounting records.

  • defaultPurchasePostingInvoiceSessionId

    Not used for French Market

    Not used for Spanish Market

    Used to define the Session preference for posting a purchase invoice to your accounting records.