Sending an Invoice

Overview

Endpoint: https://{base_url}/v1/seller-orders/{code}/invoice/
Method: PATCH
Headers:

Authorization: JWT {id_token}
Accept: application/json
Content-Type: application/json

The URL must contain the following parameters:

code: Unique order code generated by Olist;

Payload:

url: The invoice URL for the XML file must be publicly available and accessible. Olist needs to download and save all order invoices.
It is recommended to create a pre-signed URL for the security of the client's data, duly in the HTTPS protocol for download;

Response codes:

200: Ok
400: Bad request
401: Unauthorized

Issuing an invoice

The payer data from order must be the input for the invoice customer data

Invoice Validation

The validations that are made for each invoice are:

Seller's CNPJ
The invoice must be issued by the CNPJ registered with Olist

CPF / RG of the payer
The invoice must contain the buyer's information according to the information on the order

Invoice key in valid format
The invoice key consists of 44 digits and contains information related to the seller in its composition and the last number is a check digit that is calculated on top of the previous 43.

The invoice XML file will be processed and in the following cases it will be rejected:

The customer's CPF/CNPJ is invalid;
Your company's CNPJ is invalid;
- It's invalid when the value doesn't match with the order's register.
  If so, a new XML file will be needed, and you will receive the notification below:
The invoice sent for this order is invalid, please confirm the following points in your XML file and redo the operation:
- The customer's CPF/CNPJ must be the same as your order;
- Your company's CNPJ must be the same as your order;
- If the invoice had already been sent to another order.

What happens next?

The invoice XML file will be processed asynchronous and the order status will change according to the result of the file processing.

02 - UF Code
04 - Year and month of issue
14 - CNPJ of the issuer
02 - model
03 - series
09 - NF-e number
01 - Form of issuance of the NF-e
08 - numeric code
01 - check digit

For Olist, it is necessary that the model is the 55

Unique invoice key

A note that has already been imported into Olist for one order cannot be used for another. There is a validation that checks if the note key has already been used.

But, the same note can be used for an order that has more than one volume, without problems.

Note issuance date and time

An invoice must have the date and time of issue after the date of creation of the order for the seller.

Request

curl --location --request PUT 'https://{base_url}/v1/seller-orders/{code}/invoice/' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: JWT {id_token}' \
--data '{
	"url": "http://example.com/invoices/invoice.xml"
}'

Response

{
    "url": "http://example.com/invoices/invoice.xml",
    "seller_order_code": "{code}"
}

What's Next

Notification Details