Context

This page explains how to update the statuses of sales Quotes, sales Orders, sales Delivery Notes.
The update is performed using specific GraphQL mutations and requires specifying the desired status via the updateDocumentStatus field.

• Sales Quotes

  To update the status of a sales quote, use the updateSalesQuote mutation and provide the desired status value for the updateDocumentStatus field.

  HTTP	Operation	Type	Object	DTO Why-DTOs?
  POST	Update	Mutation Why 200?	updateSalesQuote How to update?	SalesQuoteUpdateGLDtoInput

  Fields	Type	Description	Length
  updateDocumentStatus	CANCEL_DECLINE DECLINE CLOSE	Allows changing the status of the quote.
  declinedReason	String	Indicates the reason why a quote was declined	100

  updateDocumentStatus Options:

  • DECLINE: Marks a quote as declined. Optionally, use the declinedReason field to specify the reason for declining.
  • CANCEL_DECLINE: Reverts a previously declined quote back to a Pending state.
  • CLOSE: Accepts and validates the quote. Once a quote is marked as Closed, its status cannot be changed further.

  Note: To determine the current status of the document, you must read the value of the status field.
  The updateDocumentStatus field is only used for updating the document’s status.

  Fields	Type	Description
  status	String	Pending Declined Closed

• Sales Orders

  To update the status of a sales order, use the updateSalesOrder mutation and specify the desired status for the updateDocumentStatus field.

  HTTP	Operation	Type	Object	DTO Why-DTOs?
  POST	Update	Mutation Why 200?	updateSalesOrder How to update?	SalesOrderUpdateGLDtoInput

  Fields	Type	Description
  updateDocumentStatus	CLOSE	Allows changing the status of the sales order.

  updateDocumentStatus Options:

  • CLOSE: Finalizes the sales order. Once closed, no further updates to the status are allowed.

  Note: To determine the current status of the document, you must read the value of the status field.
  The updateDocumentStatus field is only used for updating the document’s status.

  Fields	Type	Description
  status	String	Pending Closed

• Sales Delivery Notes

  To update the status of a sales delivery note, use the updateSalesDeliveryNote mutation and specify the desired status for the updateDocumentStatus field.

  HTTP	Operation	Type	Object	DTO Why-DTOs?
  POST	Update	Mutation Why 200?	updateSalesDeliveryNote How to update?	SalesDeliveryNoteUpdateGLDtoInput

  Fields	Type	Description
  updateDocumentStatus	CLOSE	Allows changing the status of the delivery note.

  updateDocumentStatus Options:

  • CLOSE: Marks the delivery note as completed and finalized.

  Note: To determine the current status of the document, you must read the value of the status field.
  The updateDocumentStatus field is only used for updating the document’s status.

  Fields	Type	Description
  status	String	Pending Closed

• Sales Invoices

  For sales invoices, status updates follow a different logic and are handled via business actions rather than the updateDocumentStatus field.

  Action	Description
  closeSalesInvoice	Finalizes the invoice, indicating it is no longer editable.
  postSalesInvoice	Posts the invoice to the accounting system for processing.

  Note: To determine the current status of the document, you must read the value of the status field.
  The updateDocumentStatus field is only used for updating the document’s status.

  Fields	Type	Description
  status	String	Pending Closed Posted PartiallyCollected Collected

Recommendation

Ensure you select the appropriate status update or action based on the type of sales document and its current workflow. Follow the constraints for each document type to maintain data consistency and compliance with business rules.