put
https://{environment}.neomode.com.br/cp/management/commerce/orders/external//invoicedetails
Updates the order invoice details by identifying it using the order.ExternalId field.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
📄 Invoice
Automatic status transition
This method also updates the order status to 20 (Invoice Created).
Payload (PUT)
This payload is used to send invoice data for a specific order.
{
"invoice": {
"key": "00000000000000000000000000000000000000000000",
"number": "000022507",
"serieNumber": 10,
"totalAmount": 59.47,
"xmlUrl": "https://domain.com/order-files/{client_id}/{order_id}/xml_{invoice.key}.xml",
"fileUrl": "https://domain.com/order-files/{client_id}/{order_id}/file_{invoice.key}.pdf",
"issuanceDate": "0000-00-00T03:00:00Z",
"xmlString": "{invoice_xml_base64_encoded}"
}
}
| Field | Type | Description |
|---|---|---|
key | string | Unique access key for the invoice (usually 44 digits). |
number | string | Invoice number as issued by the system. |
serieNumber | integer | Series number of the invoice (typically related to fiscal series). |
totalAmount | number | Total value of the invoice. |
xmlUrl | string | Public URL to download the XML file of the invoice. Should follow the format with {client_id}, {order_id}, and {invoice.key}. |
fileUrl | string | Public URL to download the PDF representation of the invoice. Same dynamic placeholders apply. |
issuanceDate | string (ISO 8601) | Date and time the invoice was issued (e.g., 2024-08-04T03:00:00Z). |
xmlString | string (Base64) | Base64-encoded XML content of the invoice. Used when the file cannot be retrieved via xmlUrl. |