Sales Quote Endpoint Action Error with Manual Numbering

HI ​@PBSA 

Document Overview

This document addresses an issue encountered in Acumatica ERP when using the API to mark the first Sales Quote as primary. The error occurs only for the first quote, while subsequent quotes work as expected. This document outlines the problem, root cause analysis, and step-by-step resolution.

Problem Description

Setup

1. Manual Numbering : Manual numbering for Sales Quotes is enabled.

2. Custom Web Endpoint : A custom endpoint (QuoteEndpoint) has been created with mappings for:

· OpportunityID

· QuoteNbr

· Actions: PrimaryQuote and MarkAsConverted

3. Scenario :

· An opportunity is created with two quotes.

· A POST request is sent to /entity/Quote/0.1/SalesQuote/PrimaryQuote to mark the first quote as primary.

Error Observed

When marking the first quote as primary via the API, the following error occurs:

{

"message": "An error has occurred.",

"exceptionMessage": "Object reference not set to an instance of an object.",

"exceptionType": "System.NullReferenceException",

"stackTrace": "..."

}

· Marking the second or third quote as primary works without issue.

· The functionality works correctly in the Acumatica web interface but fails via the API.

Root Cause Analysis

The error (System.NullReferenceException) suggests that the system is attempting to access an uninitialized object or property during the API request. Key observations include:

1. Default Behavior for the First Quote :

· The first quote may already be marked as primary by default when created.

· Attempting to mark it as primary again could trigger the error.

2. API Logic :

· The API does not account for cases where the quote is already primary, leading to a null reference.

3. Edge Case Handling :

· The system logic for the PrimaryQuote action may not handle edge cases (e.g., redundant requests) gracefully.

Solution Approach

To resolve the issue, we will address the following areas:

1. Verify Default Behavior :

· Confirm if the first quote is automatically marked as primary when created.

2. Update Custom Endpoint Logic :

· Modify the custom endpoint to include additional checks before invoking the PrimaryQuote action.

3. Enable Detailed Logging :

· Capture detailed logs to identify the exact cause of the error.

4. Handle Edge Cases in API Requests :

· Ensure the API request includes all required fields and handles edge cases.

Implementation Steps

Step 1: Verify Default Behavior

1. Log into the Acumatica web interface.

2. Create a new opportunity with two quotes.

3. Check if the first quote is automatically marked as primary.

· If this is the case, update the API logic to skip the PrimaryQuote action for quotes that are already primary.

Step 2: Update the Custom Endpoint

Modify the custom endpoint XML to include a field for checking if the quote is primary:

xml

<Customization level="" description="" product-version="24.109">

<EntityEndpoint>

<Endpoint xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.acumatica.com/entity/maintenance/5.31" name="Quote" version="0.1" systemContractVersion="4">

<TopLevelEntity name="SalesQuote" screen="CR304500">

<Fields>

<Field name="OpportunityID" type="StringValue"/>

<Field name="QuoteNbr" type="StringValue"/>

<Field name="IsPrimary" type="BooleanValue"/> <!-- Add a field to check if the quote is primary -->

</Fields>

<Mappings>

<Mapping field="OpportunityID">

<To object="Quote" field="OpportunityID"/>

</Mapping>

<Mapping field="QuoteNbr">

<To object="Quote" field="QuoteNbr"/>

</Mapping>

<Mapping field="IsPrimary">

<To object="Quote" field="IsPrimary"/>

</Mapping>

</Mappings>

<Actions>

<Action name="MarkAsConverted" mappedTo="MarkAsConverted"/>

<Action name="PrimaryQuote" mappedTo="PrimaryQuote"/>

</Actions>

</TopLevelEntity>

</Endpoint>

</EntityEndpoint>

</Customization>

---

Step 3: Update the API Request Logic

Before sending the PrimaryQuote action, check if the quote is already primary. For example:

// Pseudocode for API request logic

if (!quote.IsPrimary)

{

// Send POST request to mark the quote as primary

var response = SendPostRequest("/entity/Quote/0.1/SalesQuote/PrimaryQuote", quote);

}

else

{

// Handle case where the quote is already primary

Console.WriteLine("Quote is already primary.");

}

Step 4: Enable Detailed Logging

1. Go to System > Management > Trace Settings in Acumatica.

2. Enable tracing for the CR304500 screen and the PrimaryQuote action.

3. Reproduce the issue and review the logs to identify the root cause.

Expected Outcome

After implementing the above steps:

1. The API will correctly handle cases where the first quote is already primary.

2. The NullReferenceException error will no longer occur.

3. The system will behave consistently between the web interface and the API.

Additional Notes

If the issue persists after applying these changes, consider reaching out to Acumatica support with the following information:

· Detailed logs from the trace settings.

· Customization files (e.g., the updated endpoint XML).

· Steps to reproduce the issue.

Acumatica support can provide further assistance in debugging the issue at the platform level.