SalesOpenItemSettlement

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)	`salesOpenItemSettlement`	`SalesOpenItemSettlementGLDtoInput`

Description

The SalesOpenItemSettlement service is designed to manage the settlement of open items in financial accounts, allowing users to adjust payments against outstanding invoices partially or fully.
The purpose of this action is to target open items that have not yet been fully paid (status = NOT_SPECIFIED or PARTIAL) related to a sales invoice.
A total or partial amount for each due date can be specified.
The action will then create a bank entry and modify the open items to align them with the elements mentioned in the action.

How to retrieve the IDs of open items?

Retrieving open items from accounting entries
This method is used when sales invoices have not been recorded in Sage Active, and only the accounting entries related to these invoices have been entered or imported.
Open items are accessible via accountingEntries/accountingEntryLines/accountingEntryInvoice/openItems.
Refer to the 🆕 AccountingEntry - Pending Open Items of a Specific Invoice by Due Date example in the Postman collection under the Discover DATA LOADER Query Samples section.
Retrieving open items directly from sales invoices
This approach is applicable when sales invoices are available in Sage Active.
It allows for direct access to open items without going through the accounting entries.
Use salesOpenItemSettlement for direct retrieval.
Refer to the 🆕 salesInvoice - Pending Open Items of a Specific Invoice by Due Date example in the Postman collection under the Discover DATA LOADER Query Samples section.

Functionality

Settlement of Open Items: Allows the specification and settlement of open items, adjusting the financial records accordingly.
Supports Partial and Full Payments: Users can specify either partial or full payment amounts for each open item.
Automated Financial Entry Creation: Automatically creates a financial entry in the accounting ledger for global settlement made.

Input Parameters

Settlement Details: Specify the details of the settlement.

entryDate: Mandatory, the date of the entry for the settlement.
paymentMethodId: Mandatory, the identifier for the bank account or cash where the settlement will be deposited.
description: Optional, description of the settlement action.
documentNumber: Optional, a reference number for the settlement document.
thirdPartyId: Mandatory, the identifier of the third party involved in the transaction.

Open Items: Mandatory, specify the open items and the amounts for settlement.

salesOpenItemLinkagePaidAmounts: List of open items and the amounts paid.

Response

The service can return the following fields:

accountingEntryId: Unique identifier of the created accounting entry
accountingEntryNumber: Sequential number of the accounting entry

These fields confirm that the sales invoice has been successfully posted.

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

graphQL Mutation

mutation($input: SalesOpenItemSettlementGLDtoInput!) {
  salesOpenItemSettlement(input: $input) {
    accountingEntryId
    accountingEntryNumber
  }
}

graphQL Variables

{
  "input": {
    "entryDate": "2024-01-01",
    "paymentMethodId": "815c1835-90dd-4e62-8504-79a3f97fac67",
    "description": "Full settlement of Invoice IN0022",
    "documentNumber": "IN00022",
    "thirdPartyId": "815c1835-9cb5-4e62-8504-79a3f97fac67",
    "salesOpenItemLinkagePaidAmounts": [
        {
            "openItemId": "815c1835-a4e7-4e62-8504-79a3f97fac67",
            "paidAmount": 500
        },{
            "openItemId": "815c1835-a647-4e62-8504-79a3f97fac67",
            "paidAmount": 792
        }
    ]
  }
}

Example Response: Returns the Identifiers of the Accounting Entry

{
  "accountingEntryId": "bb8f0f4d-5537-4e29-842d-6b0d9db8abfe"
  "accountingEntryNumber": 237
}