PostPurchaseInvoice

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)	`postPurchaseInvoice`	`PostPurchaseInvoiceGLDtoInput`

Description

The PostPurchaseInvoice service allows for the posting of a Purchase invoice to generate ledger entries that are associated with the Purchase invoice journal.
This service also creates ledger entries based on the provided Purchase invoice details, facilitating financial tracking and management within the system.

This functionality can be related to Open Items Settlement as it is necessary for an invoice to be posted before settlements can be applied to it.

Functionality

Ledger Entry Creation: Automatically generates a ledger entry for the Purchase invoice.
Detailed Tracking: Links the ledger entry directly to the Purchase invoice using the journal type specified.

Input Parameters

Invoice Details: Specify the details of the Purchase invoice that is being posted.

PurchaseInvoiceId: Mandatory, the unique identifier of the Purchase invoice to be posted.
accountingEntryDescription: Description of the ledger entry being created.
journalTypeId: Mandatory, the journal the ledger entry is associated with, must be PURCHASE_INVOICE type.

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

graphQL Query

mutation($input: PostPurchaseInvoiceGLDtoInput!) {
  postPurchaseInvoice(input: $input) {
    accountingEntryId
    accountingEntryNumber
  }
}

graphQL Variables

{
  "input": {
    "PurchaseInvoiceId": "96771689-53b9-4f4c-add3-40eb31e38254",
    "accountingEntryDescription": "Purchase Invoice No. 0007 27/06/2024",
    "journalTypeId": "6fdf8926-cfdd-4ef8-8f89-39d6bfa622da"
  }
}

Example Response: Returns the Identifiers of the Accounting Entry

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