SalesOrder

HTTP Operation Type Object DTO Why-DTOs?
Mutation Why 200? createSalesOrder SalesOrderCreateGLDtoInput
Mutation Why 200? updateSalesOrder How to update? SalesOrderUpdateGLDtoInput
Mutation Why 200? deleteSalesOrder SalesOrderDeleteGLDtoInput
Query salesOrders filtered by id Why?  
Query salesOrders  
Query salesOrderLines  
Quick Tips

It is possible to query either salesOrder or directly from salesOrderLines.

  • Querying salesOrder allows you to retrieve entire documents with all their associated line items.
    This is useful when you need the complete context of a document, including all details of the related lines.
  • Querying salesOrderLines directly is beneficial when you want to filter or aggregate specific line item data across multiple documents, such as analyzing product sales, quantities, or prices.

More info API resources overview / 📝some Filter vs. Direct Line Filtering

Description

Both known as Sales orders in the API context and in the product interface.
This resource serves as the comprehensive record for managing customer orders within the order-to-cash process.
Utilizing the standardized and custom data fields, it captures detailed information such as customer codes, discounts, and product lines, which are essential for fulfilling customer orders.

img

To see examples of mutations that include the adding of Order :
download the Postman collection: Quick start / 5. Test your first query in Postman.

To change the Status of a salesOrder, refer to the global sales documents page, which details the available options depending on the document type. API resources overview / 📝 Update Document Status

graphQL Mutation
mutation ($values: SalesOrderCreateGLDtoInput!) {  
  createSalesOrder(input: $values) {
    id
    operationalNumber
  }
}
graphQL Variables
{
  "values": {
    "customerId": "{customerId}",
    "documentDate": "2023-12-05",
    "lines": [
      {
        "productId": "{productId1}",
        "totalQuantity": 50,
        "unitPrice": 11,
        "firstDiscount": 5
      },
      {
        "productId": "{productId2}",
        "totalQuantity": 1,
        "unitPrice": 140
      }
    ]
  }
}
Example of Response
{
    "data": {
        "createSalesOrder": {
            "id": "e451aff7-074f-4e72-a6fb-4ea25e9d9c64",
            "operationalNumber": "0027"
        }
    }
}
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?

salesOrders

Common to all documents

Fields Type Description Length
id UUID Id  
creationDate DateTime Creation Date  
modificationDate DateTime Modification Date  
sourceType
  • SALES
  • PUBLIC_API
 indicates the origin of the salesOrder (SALES=Manual entry)  
       
General Infos      
customer Customer Fields of Customer  
customerId UUID ID of the Customer entity. No mandatory for Quote  
documentDate DateTime Document Date  
operationalNumber String Document Number 50
status String
  • Pending
  • Closed
 15
socialName String Social Name 50
contactName String Contact Name 50
contactPhone String Contact Phone 15
contactEmail String Contact Email 50
contactJobAreaId UUID Id of the Contact Job Area  
countryAcronym String Country Acronym 2
       
Order Lines      
lines[] Array Document Lines  
       
Totals and discount      
totalNet Decimal Amount after discounts, before taxes.  
totalGross Decimal Total amount before discounts and taxes.  
totalDiscount Decimal Sum of all discounts applied.  
totalCustomerDiscount Decimal Discount specific to the customer.  
totalLiquid Decimal Final amount due, including taxes.  
totalVat Decimal Total Value Added Tax (VAT) applied.  
totalVatBase Decimal Total taxable base before VAT.  
totalFeeSurcharge Decimal Total equivalence surcharge applied, based on VAT.  
totalVatFee Decimal VAT amount used as the base for the surcharge.  
discount Decimal Specific discount applied.  
       
Notes      
comments String Notes for the customer/recipient of the document 1000
remarks String Internal notes for the document 1000
       
Customer Information      
documentID String Identification Number 20
documentType DocumentType Fields of DocumentType used for identification purposes  
documentTypeId UUID Identifier of the document type  
vatNumber String Vat Number 20
invoiceEmail String Invoice Email 50
hasEquivalenceSurcharge Boolean Subject to the equivalence surcharge regime  
mainAddress ObjectType Main Address  
deliveryAddress ObjectType Delivery Address  
salesDiscountGroup SalesDiscount Fields of SalesDiscount  
salesDiscountGroupId UUID Sales Discount ID  
salesTariff SalesTariff Fields of SalesTariff  
salesTariffId UUID Sales tariff ID  

Specific to sales order documents

Fields Type Description
updateDocumentStatus
  • CLOSE
 Allows changing the status of the quote.
Info
  • customerId: A unique identifier (UUID) for the Customer entity.
  • totalGross: Represents the total amount before any discounts or taxes are applied. It includes the sum of all item prices at their full value.
  • totalDiscount: The aggregated discount amount applied to the document, including all types of discounts that reduce the gross total.
  • totalNet: The total amount after applying discounts but before adding taxes. It represents the taxable base amount.
  • discount: Represents a specific discount amount applied within the document. This can be a percentage or a fixed amount reduction.
  • totalCustomerDiscount: A discount specifically applied based on customer-specific conditions, such as loyalty discounts or promotional offers tailored to the customer.
  • totalLiquid: The total payable amount, which includes taxes and any additional fees. This represents the final amount due.
  • totalVat: The total Value Added Tax (VAT) calculated on the taxable base. This amount represents the sum of all VAT applied across items in the document.
  • totalVatBase: The total taxable base amount before VAT is applied. This is the sum of all net amounts subject to VAT.
  • hasEquivalenceSurcharge / totalFeeSurcharge / totalVatFee :

    unused for the French market

    Indicates whether a customer is subject to the equivalence surcharge regime.

    The equivalence surcharge (totalFeeSurcharge), as applied in Spain, is a form of simplified VAT for retail traders who cannot recover VAT.
    The rates of the equivalence surcharge vary according to the VAT rate applicable to the products, with surcharge rates of 5.2% for products with a general VAT of 21%, 1.4% for products with a reduced VAT of 10%, and other rates for different products or categories. The equivalence surcharge is calculated on amount of general VAT (totalVatFee).

    unused for the German market

  • socialName :

    mandatory for the French market

    no mandatory for the Spanish market

    no mandatory for the Germany market

  • vatNumber : An EU VAT Number is a unique identifier for tax purposes within the European Union, used primarily for cross-border transactions. It starts with a two-letter country code followed by a series of numbers and sometimes letters, varying by country.

    mandatory for VIES customers

    no mandatory for Spanish market

    no mandatory for Germany market

  • documentId : Identification number, value formats may differ depending on legislationCode.
    • For a French , you can fill any SIREN of 9 characters or any SIRET of 14 characters.
      The value is not mandatory.
    • For a German , you may enter either a Steuer-IdNr with exactly 11 characters or another value ranging from 11 to 14 characters.
      The value is not mandatory.
    • For a Spanish , you need to fill a valid NIF/DNI/NIE number.
      The value is mandatory.
  • documentTypeId: This functionality determines the corresponding document type based on the document number provided.
    This determination is vital for verifying the real existence of a customer, thereby ensuring their authenticity and compliance with regulations.

Specific to sales order documents

  • Status:
    • Pending: The order is in progress and can be modified.
    • Closed: The order can no longer be modified; it has either been transferred to a delivery note or it has been closed.

salesOrders/lines or salesOrderLines

If the query targets salesOrders, then use lines to get the details of the lines.
If the query targets salesOrderLines, access the following fields directly, including the option to retrieve information on the parent salesOrders.

Common to all documents

Fields Type Description Length
id UUID Id  
creationDate DateTime Date of creation  
modificationDate DateTime Last modification date  
       
salesOrders Parent Information      
salesOrders salesOrder Fields of the parent salesOrders 36
salesOrderId UUID salesOrder ID  
       
Product Information      
product Product Fields of Product 36
productId UUID Product ID  
productCode String Product code 15
productName String Product name 2500
       
unitOfMeasurement Unit of Measurement Fields of Unit of Measurement  
unitOfMeasurementId UUID Unit of Measurement ID  
       
Tax and Price Information      
totalQuantity Decimal Quantity product  
unitPrice Decimal Unit price  
vatPercentage Decimal VAT percentage  
equivalenceSurchargePercentage Decimal Surcharge percentage  
       
Totals      
totalNet Decimal Amount after discounts, before taxes.  
     
totalGross Decimal Total amount before discounts and taxes.  
totalDiscount Decimal Sum of all discounts applied.  
totalCustomerDiscount Decimal Discount specific to the customer.  
totalLiquid Decimal Final amount due, including taxes.  
totalVat Decimal Total Value Added Tax (VAT) applied.  
totalVatBase Decimal Total taxable base before VAT.  
totalFeeSurcharge Decimal Total equivalence surcharge applied, based on VAT.  
totalVatFee Decimal VAT amount used as the base for the surcharge.  
       
Discounts      
firstDiscount Decimal First discount percentage  

Specific to sales order document lines

Fields Type Description Length
salesQuoteLine SalesQuoteLine Fields of SalesQuoteLine  
salesQuoteLineId UUID Sales Quote Line ID  
pendingQuantity Decimal Pending Quantity  
status String
  • Pending
  • Completed
  • Partial
 15

Info

  • unitOfMeasurementId: UUID specifying the ID of the unit of measurement associated with the product.

  • firstDiscount: Various levels of discounts applicable to the document line. These are optional fields and are usually filled in based on promotional schemes or contractual obligations.

  • productId: The unique identifier for the product. Automatically filled when selecting a product.

  • vatPercentage: The percentage of Value Added Tax (VAT) applicable to this line. Important for accounting and for generating accurate invoices.
  • equivalenceSurchargePercentage: The percentage of equivalence surcharge applied in Spain .

Specific to sales order document lines

  • pendingQuantity: The quantity of the sales order line that is still pending. This integer represents the amount of product yet to be fulfilled.
  • salesQuoteLineId: ID of the sales quote line that was used to define the order when generating an order from a quote.
  • status: The current status of the Sales Order Line, indicating the processing stage of this specific line item within the order. Possible values are:
    • Pending: The line item is acknowledged but not yet in process.
    • Completed: The line item has been fully processed and shipped.
    • Partial: The line item is partially fulfilled with more items yet to be processed.

salesOrders/addresses

Common to all documents

Do not use the addresses[] array.
Instead, use mainAddress for the primary address and deliveryAddress for the delivery address.
Each of these objects contains only one address, representing a singular primary or delivery address, respectively.

Fields Type Description Length
countryId UUID Country Id  
country String Fields of Country  
countryIsoCodeAlpha2 String Country Code 2
countryName String CountryName  
name String Code 50
firstLine String First Line 35
secondLine String Second Line 35
city String Town 35
zipCode String Postal Code 9
province String Province 25
Info
  • countryIsoCodeAlpha2 : ISO2 country code.
    This field can be used for creation and serves as a simple alternative to assign the country of the address by using the ISO2 code directly, rather than the country ID in the Countries resource.