GenerateCreditNote

Quick Links

Accounts Accounting Entries Products Customers Sales quotes Sales invoices Suppliers Purchase invoices

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 Why 200?)	`generateCreditNote`	`GenerateCreditNoteGLDtoInput`

Description

The GenerateCreditNote service allows you to create a full or partial credit note for an invoice that must be in Closed or Posted status directly through the API.

This service facilitates the automated creation of credit notes to adjust or cancel issued invoices.

Functionality

Full Credit Note: If only the invoice ID is provided, a credit note for the total amount of the invoice is generated.
Partial Credit Note: If a lines block is provided in the request, a partial credit note can be generated, specifying the affected products and quantities to be deducted.
This feature is designed to handle credit notes for product returns or service cancellations, rather than financial credit notes related to price reductions.
For this reason, it is sufficient to specify the products and quantities without requiring the unit price to be mentioned.
Invoice Status Requirement: Only invoices in Closed or Posted status can be processed.

Input Parameters

Invoice Details: Specify the details of the invoice for which a credit note is being created.

id: Mandatory, the unique identifier of the invoice that requires a credit note.
lines: Optional, an array of specific invoice lines for which a partial credit note is generated.

Response

The service returns a GenerateCreditNoteOutputGLDto object containing the following fields:

id: The unique identifier of the credit note created.

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 GenerateCreditNote service?

Case 1: Full Credit Note

If only the invoice ID is provided, a credit note is generated for the entire invoice amount.

graphQL Query

mutation($input: GenerateCreditNoteGLDtoInput!) {
  generateCreditNote(input: $input) {
    id
  }
}

graphQL Variables

{
  "input": {
    "id": "7af9f050-4a34-4a0b-a1af-30fe00a38abc"
  }
}

Example Response

{
    "data": {
        "generateCreditNote": {
            "id": "0e1987c3-f762-4906-8b26-42e4a4c36079"
        }
    }
}

Case 2: Partial Credit Note

If a lines block is provided, a partial credit note is generated, specifying which products, quantities, and amounts are affected.

graphQL Query

mutation($input: GenerateCreditNoteGLDtoInput!) {
  generateCreditNote(input: $input) {
    id
  }
}

graphQL Variables

{
  "input": {
    "id": "7af9f050-4a34-4a0b-a1af-30fe00a38abc",
    "lines": [
      {
        "productId": "e9d05ca3-79f8-4f50-ad2e-14dfa3d5604e",
        "quantity": 1.00
      },
      {
        "productId": "a3f29b17-5c2d-4d8e-91f1-9b8dcf1a8d3c",
        "quantity": 2.50
      }
    ]
  }
}

Example Response

{
    "data": {
        "generateCreditNote": {
            "id": "3b12a8d2-9b4d-4c6d-8e47-10f6e2d9e7fa"
        }
    }
}_