CloseSalesInvoice

HTTP	Operation	Type	Object	DTO Why-DTOs?
POST	Create	⚙️ ActionThe action resource represents a type of object that differs from standard queries or mutations. For a query, it returns a result already prepared by Sage Active, with no possibility to add filters, sorts, or explore the data further, or it executes an action (e.g., sending an email). For a mutation, it executes a specific business action, also carried out by Sage Active, which will impact the data (e.g., generating a credit note from an invoice). (Mutation)	`closeSalesInvoice`	`CloseSalesInvoiceGLDtoInput`

Description

The CloseSalesInvoice service allows for confirming a sales invoice, meaning its content can no longer be modified.
This step is essential to proceed with posting the invoice, which generates accounting entries and enables tracking payments associated with the invoice.

After closing, the invoice status changes from Pending (Draft) to Closed (Unposted), making it ready for posting and further financial processing.

Functionality

Invoice Confirmation: Locks the invoice content, preventing further modifications.
Status Update: Changes the invoice status from Pending (Draft) to Closed (Unposted).
Prepares for Posting: Makes the invoice eligible for posting, which will generate accounting entries and allow payment tracking.

Input Parameters

Invoice Details: Specify the details of the sales invoice to be closed.

salesInvoiceId: Mandatory, the unique identifier of the sales invoice to be closed.

Response

The service can return the following fields:

id: Unique identifier of the closed sales invoice
operationalNumber: Sequential number of the invoice in the operational process

These fields confirm that the invoice has been successfully closed.

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?

How to use the CloseSalesInvoice service?

GraphQL Mutation

mutation($input: CloseSalesInvoiceGLDtoInput!) {
  closeSalesInvoice(input: $input) {
    id
    operationalNumber
  }
}

GraphQL Variables

{
  "input": {
    "salesInvoiceId": "96771689-53b9-4f4c-add3-40eb31e38254"
  }
}

Example Response

{
    "data": {
        "closeSalesInvoice": {
            "id": "96771689-53b9-4f4c-add3-40eb31e38254",
            "operationalNumber": "0038"
        }
    }
}