1.2 Status

Analog to Orders, the Invoices entity also possesses statuses which can be populated and used to designated the current situation of the invoice.

Below are the available statuses of invoices as well as an explanation of each one:

  • Open

    • Used to refer when an invoice is just created, and still was not sent nor paid by the customer.

  • Delivery

    • Delivery status is used to inform that the customer received the invoice, most frequently this status is populated when a physical copy of the invoice is delivered to the customer at the moment of the delivery of the goods purchased.

  • Closed

    • Defines that the invoice was paid for by the customer.

  • Cancelled

    • States that the invoice was cancelled.

Important to notice rewards > generate points based on delivery or closed whichevers comes first.

 

Property

Description

Required

Example

status

The invoice status.

Allowed values: OPEN, DELIVERED, CLOSED, CANCELLED

true

"CLOSED"