Skip to main content

Create and Manage Invoices via the API

Set Brandboom to API invoicing, create invoices through the API, and understand how buyers can accept, decline, or request changes before an invoice is finalized.

Updated today

How-to

You will need to decide how you would like to create invoices:

  1. Navigate to the showroom settings and click “Order Options”

  2. Locate the “Create Invoices” setting and select one of these options.

    1. API only - Invoices will be generated through the API. You can enable the “Require Invoice Approval from Buyers” option. When activated, buyers must approve invoices before they are finalized. For detailed instructions on creating invoices via API, please refer here.

    2. Manually - Invoices can be created in Brandboom or through API manually. However, the “Require Invoice Approval” feature will be disabled.

NOTE:

  • Switching from Manual to API only invoice mode will affect previous orders and hide the “Create Invoice” button on the action bar of completed un-invoiced orders.

  • Switching from API to Manual invoice mode will affect previous orders and show the “Create Invoice” button on the action bar of completed un-invoiced orders.


Invoicing via API

  1. Create a new order and/or open an existing order (Marketplace orders can’t be invoiced via API)

    • While the invoice is still pending, any changes can be saved, and the invoice can be resent for approval.

    Order page showing the option to create an invoice through the API while the order is open.

  2. Use the API to create an invoice. The Invoice Approval Banner on the order page will say Pending Buyer Approval.

    • When creating the invoice via the API, the sendEmail parameter controls whether an email notification is sent to the buyer. If sendEmail is set to true, the buyer will receive an email.

  3. While the invoice is pending, you can make changes and resend it for approval. See below for how buyers will see the invoice.

Order page with the Invoice Approval Banner showing Pending Buyer Approval.


How Buyers Interact with API Invoices

After you send the invoice, the buyer can take one of three actions:

1. Accept - If the buyer accepts the invoice, it is finalized. The Invoice Approval Banner will be updated to reflect that it has been accepted, and no further changes can be made. You can then proceed with processing the order.

  • Seller

Seller view showing an accepted API invoice in the approval banner.

  • Buyer

Buyer view of the invoice after accepting it.

2. Decline - If the buyer declines the invoice, a modal will appear prompting them to provide a reason. After they decline, the action bar for both you and the buyer will disappear, and you will not be able to process the invoice. The Invoice Approval Banner will show that the buyer has declined the invoice.

NOTE: You can still edit the invoice on the page, but you cannot resend it for approval.

Decline invoice modal prompting the buyer to enter a reason for declining.

  • Seller

Seller view showing the invoice marked as declined in the approval banner.

  • Buyer

Buyer view showing the declined invoice state.

3. Request Changes - If the buyer requests changes, a modal will appear where they must input the requested updates. The Invoice Approval Banner will be updated to “Pending Change Request,” and the invoice status will change to “Needs Edit” for the seller. You can click the See “Change Request” link in the banner to view the buyer’s notes. You must then update the invoice through the API and re-send it to the buyer for approval.

Request changes modal where the buyer enters updates needed before approving the invoice.

  • Buyer

Buyer view showing the invoice after submitting a change request.

  • Seller

Seller view showing the Pending Change Request banner on the invoice.

Seller view showing the invoice status updated to Needs Edit after a buyer requests changes.

The buyer will review the updated invoice and can choose to accept, decline, or request more changes. You must wait for their decision after each revision and are required to resend the invoice for approval following any requested changes.


Related Links

Did this answer your question?