RecreatePdfAPI

RecreatePdfApi: Description

The class RecreatePdfApi can be used to regenerate the PDF file of invoices or dunnings via Salesforce flows, own Apex code, or a REST endpoint.

Use this when a finalized record's PDF must be refreshed without changing any invoice or dunning data – for example, after a template change, or as the post-processing step that follows Avalara response mapping.

For the corresponding manual operation in the user interface, see Recreating Invoice PDF.

Invocable Method

The method is exposed as an invocable action (Recreate PDF) for use in flows, as a static Apex method, and via a REST endpoint.

Limitations

The records passed to a single call must meet the following criteria:

• All record IDs must be of the same SObject type. Mixing Invoice__c and Dunning__c in a single call is rejected.
• Only Invoice__c and Dunning__c records are supported.

• Records must have an allowed status:

  • For invoices: Open, Paid, Settled, Canceled, Closed
  • For dunnings: Closed

Request Parameters

Response Parameters

The method returns a List<Id> of chain IDs. A single chain processes the whole input list, so every element of the returned list holds the same chain ID – Salesforce's invocable contract requires the output list size to equal the input list size. Direct Apex callers typically just read the first element.

Error Handling

Apex and Invocable Method

The API may throw ONB2.Exceptions.InvalidParameterException with one of the following messages:

REST Endpoint

Over the REST endpoint, error conditions are translated into HTTP responses as follows:

RecreatePdfApi: Example Use Cases

Using Salesforce Flow

Assume the following use case: You want to regenerate the PDF of an invoice whenever the field EmailTemplate__c is updated, so that the latest template content is reflected in the document. Now you can use this field modification as a condition to trigger a Salesforce flow that calls the Recreate PDF action.

You can set up the flow as follows:

Depending on your specific use case, the flow setup will vary. The trigger object can also be Dunning (ONB2__Dunning__c).

Using Apex Code

Assume your business has developed an own integration with JustOn Billing & Invoice Management that updates invoice data. Now you need a piece of Apex code that calls the class RecreatePdfApi after the update, like, for example

public class CustomRecreatePdf {

    public void executeRecreatePdf(List<Id> recordIds) {
        Id chainId = ONB2.RecreatePdfApi.recreatePdf(recordIds)[0];

        // chainId can be used to poll BatchJobChain__c for progress.
        // chainId is null if none of the passed IDs match an existing record.
    }
}

Using REST

JustOn Billing & Invoice Management also accepts an HTTP POST request at the following endpoint:

https://INSTANCE.salesforce.com/services/apexrest/RecreatePdfApi

Replace INSTANCE with the actual Salesforce instance or custom domain where JustOn is installed.

The body of the request must be in JSON format and contain a list of invoice or dunning IDs:

{"recordIds":["id1","id2"]}

A successful call returns HTTP status code 200 and the chain ID in the response body:

"a0v5000000xYzAaAAB"

For details about authentication and possible HTTP status codes, see Step Two: Set Up Authorization and RestResponse Class in the Salesforce Developer Documentation.