Customer Credit invoice is a document automatically generated by VTEX after the customer makes a purchase using Customer Credit as a payment method and the order is billed.

In cases of installment purchases, invoices are generated according to the number of installments. For example, a purchase made with payment in 10 installments on Customer Credit will generate 10 invoices related to the same order number.

The Order invoice and the Customer Credit invoice are different documents. The Order invoice is issued for all purchases made in a store, regardless of the payment method selected. The Customer Credit invoice is additionally issued only for purchases made using the Customer Credit payment method. Learn more about invoiced orders in How to invoice an order.

This guide describes how to manage Customer Credit invoices in your store by performing the following actions through the endpoints of the Customer Credit API:

• Check information:

  • About a specific Customer Credit invoice
  • Of all invoices issued to a Customer Credit account
  • Regarding Customer Credit invoices created for all users in a VTEX store

• Update invoice details

• Postpone the due date of an invoice

• Record payment of an invoice

• Cancel an invoice

For more information about Customer Credit functionalities, access Customer Credit - Overview and Customer Credit - Getting Started.

When you want to check details about a specific Customer Credit invoice, you can use the Retrieve invoice by ID endpoint. In this request, you must send the Customer Credit account and invoice identification (creditAccountId and invoiceId) as path parameters.

See an example below using the account 11111111111_CPF and invoice 7583E36F101C461094AB6CA68FA8EE2C-01.

GET - Retrieve invoice by ID

https://{accountName}.{environment}.com.br/api/creditcontrol/accounts/11111111111_CPF/invoices/7583E36F101C461094AB6CA68FA8EE2C-01

Response body example

You can also check some details of a Customer Credit invoice details using the VTEX Admin. To do that, go to Apps > Customer Credit > Invoices, and click on the desired invoice.

To check details of all invoices issued on a Customer Credit account, you can use the Retrieve invoices by Customer Credit account ID endpoint. In this request, you must send the account identification (creditAccountId) as a path parameter.

See an example below using the account 111111111_CPF:

GET - Retrieve invoices by Customer Credit account ID

https://{accountName}.{environment}.com.br/api/creditcontrol/accounts/11111111111_CPF/invoices/

Response body example

You can also use VTEX Admin to check the list of all invoices issued to a Customer Credit account. To do that, go to Apps > Customer Credit > Accounts, and click on the desired invoice.

To list all invoices created in Customer Credit accounts of a VTEX store, you can use the Search all invoices endpoint.

GET - Search all invoices

https://{accountName}.{environment}.com.br/api/creditcontrol/invoices/

Response body example

Through the Change invoice endpoint, you can update an invoice status, create an observation note, or add a link to assist your customer in the payment process.

See the example below, modifying the status, creating a observation note and adding the payment link to the invoice 7583E36F101C461094AB6CA68FA8EE2C-01 of account 111111111_CPF:

PUT - Change invoice

https://{accountName}.{environment}.com.br/api/creditcontrol/accounts/11111111111_CPF/invoices/7583E36F101C461094AB6CA68FA8EE2C-01

Request body example

The success of this call is confirmed by the 200 OK status and the empty response body.

To confirm the information was updated, use the Retrieve invoice by ID endpoint.

Response body example

You can also access your store Admin (Apps > Customer Credit > Account Details), select the desired account and invoice to confirm that the information was updated.

To change the original due date of an invoice in Customer Credit, allowing the customer more time to complete the payment, you can use the endpoint Postpone an invoice.

However, before defining how many additional days of payment you will provide to the customer, you need to enable the option to postpone payment in your store's settings. To do this, you must use the endpoint Create or change store configuration.

The following parameters of this endpoint are responsible for enabling the option to postpone payment of invoices in the store:

• invoicePostponementLimit: The maximum number of times allowed to extend an invoice.
• maxPostponementDays: The maximum number of days an invoice can be extended.
• postponementEnabled: Allow extension of invoices in the store.

The settings available in the Create or change store configuration endpoint apply to all Customer Credit accounts registered in a VTEX store. It is not possible to customize these settings for each specific Customer Credit account of a given store.

See the example below, where a store is configured to allow invoice expiration dates to be extended up to 3 times and for a maximum period of 30 days in total.

PUT - Create or change store configuration

https://{accountName}.{environment}.com.br/api/creditcontrol/storeconfig

Request body example

The response to this request provides updated information about postponing invoices and other settings already applied in the store.

Response body example

For more information about other configuration fields available for Customer Credit in a store, access the Create or change store configuration endpoint reference.

Once invoice postponement is enabled, you can postpone a specific invoice. See the example below in which 5 additional days will be granted to pay an invoice with an original due date of May 20, 2024.

PUT - Postpone an invoice

https://{accountName}.{environment}.com.br/api/creditcontrol/accounts/11111111111_CPF/invoices/7583E36F101C461094AB6CA68FA8EE2C-01/postponement

Request body example

The success of this call is confirmed by the 200 OK status and the empty response body.

To confirm that the new invoice due date has been modified, use the Retrieve invoice by ID endpoint and check the updated information in the dueDate field.

GET - Retrieve invoice by ID

https://{accountName}.{environment}.com.br/api/creditcontrol/accounts/11111111111_CPF/invoices/7583E36F101C461094AB6CA68FA8EE2C-01

Response body example

You can also verify the new invoice due date through your store Admin (Apps > Customer Credit > Account Details).

To confirm payment of a Customer Credit invoice, you can use the Mark an invoice as paid endpoint.

See example of payment of invoice 7583E36F101C461094AB6CA68FA8EE2C-01 in account 111111111_CPF:

POST - Mark an invoice as paid

https://{accountName}.{environment}.com.br/api/creditcontrol/accounts/11111111111_CPF/invoices/7583E36F101C461094AB6CA68FA8EE2C-01/payments

Response body example

You can also confirm the invoice payment through your store Admin (Apps > Customer Credit > Account Details).

If you wish to cancel a Customer Credit invoice that has been issued but no longer needs to be paid, for example when an order is cancelled, you can use the Cancel invoice endpoint.

An invoice that already has a paid status can no longer be canceled.

See an example of canceling the invoice 7583E36F101C461094AB6CA68FA8EE2C-01 on account 111111111_CPF:

DEL - Cancel invoice

https://{accountName}.{environment}.com.br/api/creditcontrol/accounts/11111111111_CPF/invoices/7583E36F101C461094AB6CA68FA8EE2C-01

The success of this call is confirmed by the 200 OK status and the empty response body.

To confirm the invoice was canceled, use the Retrieve invoice by ID endpoint.

Response body example

You can also confirm the invoice cancellation through your store Admin (Apps > Customer Credit > Account Details).