SalesDeliveryNote | Sage Active Developer

HTTP	Operation	Type	Object	DTO Why-DTOs?
POST	Create	Mutation	`createSalesDeliveryNote`	`SalesDeliveryNoteCreateGLDtoInput`
POST	Update	Mutation	`updateSalesDeliveryNote`	`SalesDeliveryNoteUpdateGLDtoInput`
POST	Delete	Mutation	`deleteSalesDeliveryNote`	`SalesDeliveryNoteDeleteGLDtoInput`
POST	Read	Query	`salesDeliveryNotes filtered by id` Why?
POST	List	Query	`salesDeliveryNotes`
POST	List	Query	`salesDeliveryNoteLines`

Quick Tips

It is possible to query either salesDeliveryNote or directly from salesDeliveryNoteLines.

Querying salesDeliveryNote 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 salesDeliveryNoteLines 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 delivery notes in the API context and in the product interface.
This resource is the backbone for organizing and managing the shipping and handling details associated with sales orders.
With the flexibility to incorporate both standard and customized fields, Sales Delivery Notes offer granular visibility into the logistical aspects of the order-to-cash process.
This is critical for ensuring timely and accurate deliveries to customers.

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

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

Would you like to see an example of how to add a delivery note?

graphQL Mutation

mutation ($values: SalesDeliveryNoteCreateGLDtoInput!) {  
  createSalesDeliveryNote(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": {
        "createSalesDeliveryNote": {
            "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?

salesDeliveryNotes

Common to all documents

Fields	Type	Description	Length
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
sourceType SSystem field that cannot be assigned	null PUBLIC_API	indicates the origin of the salesDeliveryNote (null=Manual entry)

*General Infos*
customer DATALOADERUtilize the DATALOADER feature to enrich your query by adding additional resource fields directly in the query.	Customer	Fields of Customer
customerId *The value of the field or object is mandatory NThe value of this field cannot be modified after the record is created	UUID	ID of the Customer entity. No mandatory for Quote See InfoAdditional information is available in the Info block below
documentDate	DateTime DateThe GraphQL field type is DateTime, but only the date value is considered, the time value is ignored if provided.	Document Date
operationalNumber	String	Document Number	50
status	String	See InfoAdditional information is available in the Info block below Pending Closed	15
socialName NThe value of this field cannot be modified after the record is created	String	Social Name See InfoAdditional information is available in the Info block below	50
contactName	String	Contact Name	50
contactPhone	String	Contact Phone	15
contactEmail	String	Contact Email	50
NEWNew Feature Recently Added. (Introduced in the last version as well as in the previous version) contactJobAreaId	UUID	Id of the Contact Job Area
countryAcronym	String	Country Acronym	2

*DeliveryNote Lines*
lines[] *The value of the field or object is mandatory	Array	Document Lines

*Totals and discount*
totalNet	Decimal	Amount after discounts, before taxes. See InfoAdditional information is available in the Info block below
totalGross	Decimal	Total amount before discounts and taxes. See InfoAdditional information is available in the Info block below
totalDiscount	Decimal	Sum of all discounts applied. See InfoAdditional information is available in the Info block below
totalCustomerDiscount	Decimal	Discount specific to the customer. See InfoAdditional information is available in the Info block below
totalLiquid	Decimal	Final amount due, including taxes. See InfoAdditional information is available in the Info block below
totalVat	Decimal	Total Value Added Tax (VAT) applied. See InfoAdditional information is available in the Info block below
totalVatBase	Decimal	Total taxable base before VAT. See InfoAdditional information is available in the Info block below
totalFeeSurcharge	Decimal	Total equivalence surcharge applied, based on VAT. See InfoAdditional information is available in the Info block below
totalVatFee	Decimal	VAT amount used as the base for the surcharge. See InfoAdditional information is available in the Info block below
discount	Decimal	Specific discount applied. See InfoAdditional information is available in the Info block below

*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 See InfoAdditional information is available in the Info block below	20
vatNumber	String	Vat Number See InfoAdditional information is available in the Info block below	20
invoiceEmail	String	Invoice Email	50
hasEquivalenceSurcharge	Boolean	Subject to the equivalence surcharge regime See InfoAdditional information is available in the Info block below
mainAddress	ObjectType	Main Address
deliveryAddress	ObjectType	Delivery Address
salesDiscountGroup DATALOADERUtilize the DATALOADER feature to enrich your query by adding additional resource fields directly in the query.	SalesDiscount	Fields of SalesDiscount
salesDiscountGroupId	UUID	Sales Discount ID
salesTariff DATALOADERUtilize the DATALOADER feature to enrich your query by adding additional resource fields directly in the query.	SalesTariff	Fields of SalesTariff
salesTariffId	UUID	Sales tariff ID

Specific to sales delivery note documents

Fields	Type	Description
updateDocumentStatus MutThis field can only be used in mutations, not in queries	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

Specific to sales delivery documents

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

salesDeliveryNotes/lines or salesDeliveryNoteLines

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

Common to all documents

Fields	Type	Description	Length
idSSystem field that cannot be assigned	UUID	Id
creationDate SSystem field that cannot be assigned	DateTime	Date of creation
modificationDate SSystem field that cannot be assigned	DateTime	Last modification date

*salesDeliveryNotes Parent Information*
salesDeliveryNotes DATALOADERUtilize the DATALOADER feature to enrich your query by adding additional resource fields directly in the query.	salesDeliveryNote	Fields of the parent salesDeliveryNotes	36
salesDeliveryNoteId	UUID	salesDeliveryNote ID

*Product Information*
product DATALOADERUtilize the DATALOADER feature to enrich your query by adding additional resource fields directly in the query.	Product	Fields of Product	36
productId	UUID	Product ID See InfoAdditional information is available in the Info block below
productCode	String	Product code	15
productName	String	Product name	2500

unitOfMeasurement DATALOADERUtilize the DATALOADER feature to enrich your query by adding additional resource fields directly in the query. NEWNew Feature Recently Added. (Introduced in the last version as well as in the previous version)	Unit of Measurement	Fields of Unit of Measurement
unitOfMeasurementId DIn creation, this field can have a default value automatically calculated NEWNew Feature Recently Added. (Introduced in the last version as well as in the previous version)	UUID	Unit of Measurement ID See InfoAdditional information is available in the Info block below

*Tax and Price Information*
totalQuantity	Decimal	Quantity product
unitPrice	Decimal	Unit price
vatPercentage RThis field is read-only, its value cannot be assigned	Decimal	VAT percentage See InfoAdditional information is available in the Info block below
equivalenceSurchargePercentageRThis field is read-only, its value cannot be assigned	Decimal	Surcharge percentage See InfoAdditional information is available in the Info block below

*Totals*
totalNet	Decimal	Amount after discounts, before taxes.
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
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 See InfoAdditional information is available in the Info block below

Info

unitOfMeasurementId: NEWNew Feature Recently Added. (Introduced in the last version as well as in the previous version) 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 .

salesDeliveryNotes/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 DATALOADERUtilize the DATALOADER feature to enrich your query by adding additional resource fields directly in the query.	String	Fields of Country
countryIsoCodeAlpha2	String	Country Code See InfoAdditional information is available in the Info block below	2
countryNameRThis field is read-only, its value cannot be assigned	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.