VTEX Invoice API

openapi: 3.2.0
info:
  title: Vtex Invoice API
  version: '1.0'
  contact: {}
  description: 'Operations tagged Invoice across 2 of this provider''s published API definitions: vtex-orders-openapi-original.yml, vtex-orders-pii-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{accountName}.{environment}.com.br
  description: VTEX server URL.
  variables:
    accountName:
      description: Name of the VTEX account. Used as part of the URL.
      default: apiexamples
    environment:
      description: Environment to use. Used as part of the URL.
      enum:
      - vtexcommercestable
      default: vtexcommercestable
security:
- appKey:
  - '{{appKey}}'
  appToken:
  - '{{appToken}}'
tags:
- name: Invoice
paths:
  /api/oms/pvt/orders/{orderId}/invoice:
    post:
      tags:
      - Invoice
      summary: VTex Order invoice notification
      description: "This request is used for [invoicing an order](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/2WgQrlHTyVo4hLjhUs1LMT). Entering the order's invoice means it was successfully completed, and the order status can be changed to the `invoiced` in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196). Once an order is `invoiced`, its status cannot be changed. \n\nAfter the insertion of the invoice, the order's total value will be updated, even in [partial invoice](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe) scenarios. \n\n>❗ To avoid rounding errors, we recommend always sending the object of items being invoiced. \n\n## Partial invoices \n\nAfter adding a [partial invoice](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe), the order's value will be updated, corresponding to a partial settled value in the VTEX payment gateway. \n\nPartially invoiced orders cannot be canceled, and cancellation attempts will result in a `400` status code error. If the customer wants to replace or remove items, it is possible to [change the order](https://developers.vtex.com/docs/guides/change-order). \n\n> The partial invoices feature is available for all VTEX stores. The partial settlement in the gateway is in Beta, and requires a connector with the Payment Provider Protocol. \n\n## Returning items \n\nBesides using this endpoint for generating invoices for sold items, you can use it for generating invoices for returned items. You determine this in the request body `type` field by choosing one of the following values: \n\n- `output`: selling order invoice. \n\n- `input`: returning items invoice. \n\nBe aware of generating return invoices only after the full order amount was invoiced, otherwise, no refund will occur. \n\n## Changing the receipt code \n\nEvery time this endpoint is called using the same `invoiceNumber`, a new `receipt` code is generated, and it overrides the previous one. By doing this, you cannot change other information, only the `receipt` code.\n\n## Integration with marketplaces \n\nThe invoice should be pushed to the fulfillment account, not to the marketplace account. Once the order is invoiced, the seller should use this request to send the invoice information to the marketplace. \n\nThis endpoint is also used by the seller to send the order tracking information. However, this only should be done after the seller has the tracking information. \n\n## Permissions\n\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\n\n| **Product** | **Category** | **Resource** |\n| --------------- | ----------------- | ----------------- |\n| OMS | OMS access | **Notify invoice** |\n| OMS | OMS access | **Notify refund** | \n\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\n\n| **Role** | **Resource** | \n| --------------- | ----------------- | \n| OMS - Full access | Cancel order |\n| IntegrationProfile - Fulfillment Oms | Cancel order |\n\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). \n\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication)."
      operationId: InvoiceNotification
      parameters:
      - name: Accept
        in: header
        description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - name: Content-Type
        in: header
        description: Describes the type of the content being sent.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - name: orderId
        in: path
        description: Unique code that identifies the order whose invoice is being sent.
        example: 1172452900788-01
        required: true
        style: simple
        schema:
          type: string
          example: 1172452900788-01
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InvoiceNotificationRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  date:
                    type: string
                    description: Date and time when the notification was received.
                  orderId:
                    type: string
                    description: Identification of the order in the seller.
                  receipt:
                    type: string
                    description: Protocol code generated by the update that identifies the receipt. Every time this endpoint is called using the same `invoiceNumber`, a new `receipt` code is generated, and it overrides the previous one.
              example:
                date: '2014-02-07T15:22:56.7612218-02:00'
                orderId: '123543123'
                receipt: 38e0e47da2934847b489216d208cfd91
      deprecated: false
    servers:
    - url: https://{accountName}.{environment}.com.br
      description: VTEX server URL.
      variables:
        accountName:
          description: Name of the VTEX account. Used as part of the URL.
          default: apiexamples
        environment:
          description: Environment to use. Used as part of the URL.
          enum:
          - vtexcommercestable
          default: vtexcommercestable
  /api/oms/pvt/orders/{orderId}/invoice/{invoiceNumber}:
    patch:
      tags:
      - Invoice
      summary: VTex Update order's partial invoice (send tracking number)
      description: 'Update a given order, adding its tracking number to its [Partial invoice](https://help.vtex.com/en/tracks/pedidos--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe).


        After using this call to add a tracking number to an order, you can use the [Update order tracking status](https://developers.vtex.com/docs/api-reference/orders-api#put-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-/tracking) API request to add tracking events.


        > The `Notify invoice` resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile - Fulfillment Oms`, among other default roles available in the Admin. Learn more about the [License manager roles and resources](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc).'
      operationId: Updatepartialinvoice.SendTrackingNumber
      parameters:
      - name: Content-Type
        in: header
        description: Type of the content being sent.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - name: Accept
        in: header
        description: HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
        required: true
        style: simple
        schema:
          type: string
          default: application/json
      - name: orderId
        in: path
        description: Unique code that identifies the order whose invoice is being sent.
        example: 1172452900788-01
        required: true
        style: simple
        schema:
          type: string
          example: 1172452900788-01
      - name: invoiceNumber
        in: path
        description: Number that identifies the invoice.
        example: '000030711'
        required: true
        style: simple
        schema:
          type: string
          example: '000030711'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Updatepartialinvoice.SendTrackingNumber.Request'
            example:
              trackingNumber: '87658'
              trackingUrl: https://www.tracking.com/url
              courier: carrierOne
              dispatchedDate: '2022-02-08T13:16:13.4617653+00:00'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Updatepartialinvoice.SendTrackingNumber'
              example:
                date: '2019-02-08T13:16:13.4617653+00:00'
                orderId: 00-v5195004lux-01
                receipt: 527b1ae251264ef1b7a9b597cd8f16b9
      deprecated: false
    servers:
    - url: https://{accountName}.{environment}.com.br
      description: VTEX server URL.
      variables:
        accountName:
          description: Name of the VTEX account. Used as part of the URL.
          default: apiexamples
        environment:
          description: Environment to use. Used as part of the URL.
          enum:
          - vtexcommercestable
          default: vtexcommercestable
  /api/orders/pvt/document/{orderId}/invoices:
    post:
      tags:
      - Invoice
      summary: VTex Order invoice notification
      description: 'Once the order is invoiced, the seller should use this request to send the invoice information to the marketplace.


        We strongly recommend that you always send the object of the invoiced items. With this practice, rounding errors will be avoided.


        It is not allowed to use the same `invoiceNumber` in more than one request to the Order Invoice Notification endpoint.


        Be aware that this endpoint is also used by the seller to send the order tracking information. This, however, should be done in a separate moment, once the seller has the tracking information.


        > The `Notify invoice` resource is needed to use this API request. This is included in `OMS - Full access` and `IntegrationProfile - Fulfillment Oms`, among other default roles available in the Admin. Learn more about the [License manager roles and resources](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#).'
      operationId: InvoiceNotification2
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/orderId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InvoiceNotificationRequest_2'
            example:
              type: Output
              issuanceDate: '2010-01-31'
              invoiceNumber: '9999'
              invoiceValue: '10000'
              invoiceKey: null
              invoiceUrl: null
              courier: null
              trackingNumber: null
              trackingUrl: null
              dispatchedDate: null
              items:
              - id: '1234'
                price: 10000
                quantity: 1
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  date:
                    type: string
                    description: Date and time when the notification was received.
                  orderId:
                    type: string
                    description: Identification of the order in the seller.
                  receipt:
                    type: string
                    description: Protocol code generated by the update. It may be `null`.
                example:
                  date: '2014-02-07T15:22:56.7612218-02:00'
                  orderId: '123543123'
                  receipt: 38e0e47da2934847b489216d208cfd91
        '403':
          description: Forbidden
        '404':
          description: Not found
        '429':
          description: Too many requests
      deprecated: false
    servers:
    - url: https://{accountName}.{environment}.com.br
      description: VTEX server URL.
      variables:
        accountName:
          description: Name of the VTEX account. Used as part of the URL.
          default: apiexamples
        environment:
          description: Environment to use. Used as part of the URL.
          enum:
          - vtexcommercestable
          default: vtexcommercestable
components:
  schemas:
    Item1:
      title: Item1
      required:
      - id
      - price
      - quantity
      type: object
      properties:
        id:
          type: string
          description: ID of the SKU being invoiced.
        price:
          type: integer
          description: Price in cents of the SKU being invoiced. Do not use a decimal separator, for example, the price $24.99 corresponds to `2499`. You must insert the SKU unitary price because the VTEX system will multiply the price over the quantity.
          example: 2499
        description:
          type: string
          description: You can use this field for additional information about the SKU being invoiced.
          example: '335'
        quantity:
          type: integer
          description: Quantity currently in inventory of the SKU being invoiced.
          example: 2
      example:
        id: '1234'
        price: 10000
        description: '335'
        quantity: 1
    Updatepartialinvoice.SendTrackingNumber:
      title: Updatepartialinvoice.SendTrackingNumber
      required:
      - date
      - orderId
      - receipt
      type: object
      properties:
        date:
          type: string
        orderId:
          type: string
        receipt:
          type: string
      example:
        date: '2019-02-08T13:16:13.4617653+00:00'
        orderId: 00-v5195004lux-01
        receipt: 527b1ae251264ef1b7a9b597cd8f16b9
    Updatepartialinvoice.SendTrackingNumber.Request:
      title: Updatepartialinvoice.SendTrackingNumber.Request
      required:
      - trackingNumber
      - trackingUrl
      - courier
      - dispatchedDate
      type: object
      properties:
        trackingNumber:
          type: string
          description: The number code that identifies the order tracking.
        trackingUrl:
          type:
          - string
          - 'null'
          description: Package tracking URL.
        dispatchedDate:
          type:
          - string
          - 'null'
          description: Date when the package was dispatched. For example, 2023-01-08T13:16:13.4617653+00:00.
        courier:
          type:
          - string
          - 'null'
          description: The name of the carrier responsible for delivering the order.
      example:
        trackingNumber: '87658'
        trackingUrl: https://www.tracking.com/url
        courier: carrierOne
        dispatchedDate: '2022-02-08T13:16:13.4617653+00:00'
    InvoiceNotificationRequest:
      title: InvoiceNotificationRequest
      required:
      - type
      - issuanceDate
      - invoiceNumber
      - invoiceValue
      - items
      type: object
      properties:
        type:
          type: string
          description: 'The type of invoice. There are two possible values: **Output** and **Input**. The Output type should be used when the invoice you are sending is a selling invoice. The Input type should be used when you send a return invoice.'
          example: Output
        issuanceDate:
          type: string
          description: The invoice date is when the order was [invoiced](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/2WgQrlHTyVo4hLjhUs1LMT) in the VTEX platform, and the `IssuanceDate` is the date when the merchant registers the order's invoice in the store's system. The `IssuanceDate` can be different from the invoice date, because the merchant can register the invoice days or even months after order invoicing. You must add date and time in this field.
          example: '2019-01-31T18:25:43-05:00'
        invoiceNumber:
          type:
          - string
          - 'null'
          description: Unique code that identifies the invoice. When you call this endpoint using the same invoice number, you generate a new `receipt` code.
          example: DFG-v7731485plzv-01
        invoiceValue:
          type: string
          description: Total amount being invoiced in cents. Do not use any decimal separator. For instance, `$24.99` should be represented as `2499`.
          example: '2499'
        invoiceKey:
          type:
          - string
          - 'null'
          description: Information about invoice Key.
          example: CFe35201100063960001504590006629690333214542150
        invoiceUrl:
          type:
          - string
          - 'null'
          description: URL of the invoice. Can be used to send the URL of an XML file, for example, which is useful for some integrations.
          example: https://luxstore.com/invoices/24382.pdf
        embeddedInvoice:
          type:
          - string
          - 'null'
          description: XML text of the invoice, not the URL. This field is very important for external marketplace integrations such as Mercado Libre.
          example: '<NFe>

            <infNFe Id="NFe34687999999090910270550010000000015180000000000" versao="1.10">

            <ide>

            <cUF>37</cUF>

            <cNF>000005177</cNF>

            <natOp>Venda a vista</natOp>

            <indPag>0</indPag>

            <mod>55</mod>

            <serie>1</serie>

            <nNF>1</nNF>

            <dEmi>2018-07-06</dEmi>

            <dSaiEnt>2018-07-06</dSaiEnt>

            <tpNF>0</tpNF>

            <cMunFG>79950308</cMunFG>

            <tpImp>1</tpImp>

            <tpEmis>1</tpEmis>

            <cDV>3</cDV>

            <tpAmb>2</tpAmb>

            <finNFe>1</finNFe>

            <procEmi>0</procEmi>

            <verProc>NF-eletronica.com</verProc>

            </ide>

            <emit>

            <CNPJ>99999090998760</CNPJ>

            <xNome>NF-e Associacao NF-e</xNome>

            <xFant>NF-e</xFant>

            <enderEmit>

            <xLgr>Rua Central</xLgr>

            <nro>100</nro>

            <xCpl>Fundos</xCpl>

            <xBairro>Distrito Industrial</xBairro>

            <cMun>0000000</cMun>

            <xMun>Município</xMun>

            <UF>SP</UF>

            <CEP>0000000</CEP>

            <cPais>1058</cPais>

            <xPais>Brasil</xPais>

            <fone>1733021717</fone>

            </enderEmit>

            <IE>123456789012</IE>

            </emit>

            <dest>

            <CNPJ>00000000000000</CNPJ>

            <xNome>DISTRIBUIDORA DE AGUAS MINERAIS</xNome>

            <enderDest>

            <xLgr>AV DAS FONTES</xLgr>

            <nro>1777</nro>

            <xCpl>1001 ANDAR</xCpl>

            <xBairro>PARQUE</xBairro>

            <cMun>0000000</cMun>

            <xMun>Sao Paulo</xMun>

            <UF>SP</UF>

            <CEP>00000000</CEP>

            <cPais>1058</cPais>

            <xPais>BRASIL</xPais>

            <fone>3900000000</fone>

            </enderDest>

            <IE> </IE>

            </dest>

            <retirada>

            <CNPJ>000000000004</CNPJ>

            <xLgr>AV PAULISTA</xLgr>

            <nro>12345</nro>

            <xCpl>TERREO</xCpl>

            <xBairro>CERQUEIRA CESAR</xBairro>

            <cMun>0000000</cMun>

            <xMun>SAO PAULO</xMun>

            <UF>SP</UF>

            </retirada>

            <entrega>

            <CNPJ>00000000299000194</CNPJ>

            <xLgr>AV FARIA LIMA</xLgr>

            <nro>154400</nro>

            <xCpl>156 ANDAR</xCpl>

            <xBairro>PINHEIROS</xBairro>

            <cMun>0000308</cMun>

            <xMun>SAO PAULO</xMun>

            <UF>SP</UF>

            </entrega>

            <det nItem="1">

            <prod>

            <cProd>00001</cProd>

            <cEAN/>

            <xProd>Agua Mineral</xProd>

            <CFOP>5101</CFOP>

            <uCom>dz</uCom>

            <qCom>1000000.0000</qCom>

            <vUnCom>1</vUnCom>

            <vProd>10000000.00</vProd>

            <cEANTrib/>

            <uTrib>und</uTrib>

            <qTrib>12000000.0000</qTrib>

            <vUnTrib>1</vUnTrib>

            </prod>

            <imposto>

            <ICMS>

            <ICMS00>

            <orig>0</orig>

            <CST>00</CST>

            <modBC>0</modBC>

            <vBC>10000000.00</vBC>

            <pICMS>18.00</pICMS>

            <vICMS>1800000.00</vICMS>

            </ICMS00>

            </ICMS>

            <PIS>

            <PISAliq>

            <CST>01</CST>

            <vBC>10000000.00</vBC>

            <pPIS>0.65</pPIS>

            <vPIS>65000</vPIS>

            </PISAliq>

            </PIS>

            <COFINS>

            <COFINSAliq>

            <CST>01</CST>

            <vBC>10000000.00</vBC>

            <pCOFINS>2.00</pCOFINS>

            <vCOFINS>200000.00</vCOFINS>

            </COFINSAliq>

            </COFINS>

            </imposto>

            </det>

            <det nItem="2">

            <prod>

            <cProd>00002</cProd>

            <cEAN/>

            <xProd>Agua Mineral</xProd>

            <CFOP>5101</CFOP>

            <uCom>pack</uCom>

            <qCom>5000000.0000</qCom>

            <vUnCom>2</vUnCom>

            <vProd>10000000.00</vProd>

            <cEANTrib/>

            <uTrib>und</uTrib>

            <qTrib>3000000.0000</qTrib>

            <vUnTrib>0.3333</vUnTrib>

            </prod>

            <imposto>

            <ICMS>

            <ICMS00>

            <orig>0</orig>

            <CST>00</CST>

            <modBC>0</modBC>

            <vBC>10000000.00</vBC>

            <pICMS>18.00</pICMS>

            <vICMS>1800000.00</vICMS>

            </ICMS00>

            </ICMS>

            <PIS>

            <PISAliq>

            <CST>01</CST>

            <vBC>10000000.00</vBC>

            <pPIS>0.65</pPIS>

            <vPIS>65000</vPIS>

            </PISAliq>

            </PIS>

            <COFINS>

            <COFINSAliq>

            <CST>01</CST>

            <vBC>10000000.00</vBC>

            <pCOFINS>2.00</pCOFINS>

            <vCOFINS>200000.00</vCOFINS>

            </COFINSAliq>

            </COFINS>

            </imposto>

            </det>

            <total>

            <ICMSTot>

            <vBC>20000000.00</vBC>

            <vICMS>18.00</vICMS>

            <vBCST>0</vBCST>

            <vST>0</vST>

            <vProd>20000000.00</vProd>

            <vFrete>0</vFrete>

            <vSeg>0</vSeg>

            <vDesc>0</vDesc>

            <vII>0</vII>

            <vIPI>0</vIPI>

            <vPIS>130000.00</vPIS>

            <vCOFINS>400000.00</vCOFINS>

            <vOutro>0</vOutro>

            <vNF>20000000.00</vNF>

            </ICMSTot>

            </total>

            <transp>

            <modFrete>0</modFrete>

            <transporta>

            <CNPJ>00000000000000</CNPJ>

            <xNome>Distribuidora de Bebidas Fazenda de SP Ltda.</xNome>

            <IE>00000000999119</IE>

            <xEnder>Rua Central 100 - Fundos - Distrito Industrial</xEnder>

            <xMun>SAO PAULO</xMun>

            <UF>SP</UF>

            </transporta>

            <veicTransp>

            <placa>BXI1717</placa>

            <UF>SP</UF>

            <RNTC>123456789</RNTC>

            </veicTransp>

            <reboque>

            <placa>UUU0000</placa>

            <UF>SP</UF>

            <RNTC>123456789</RNTC>

            </reboque>

            <vol>

            <qVol>10000</qVol>

            <esp>CAIXA</esp>

            <marca>LINDOYA</marca>

            <nVol>500</nVol>

            <pesoL>1000000000.000</pesoL>

            <pesoB>1200000000.000</pesoB>

            <lacres>

            <nLacre>XYZ10231486</nLacre>

            </lacres>

            </vol>

            </transp>

            <infAdic>

            <infAdFisco>Nota Fiscal de exemplo NF-eletronica.com</infAdFisco>

            </infAdic>

            </infNFe>

            <Signature>

            <SignedInfo>

            <CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-0321120010315"/>

            <SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/>

            <Reference URI="#NFe3508059999977777777705500100000000000000000">

            <Transforms>

            <Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/>

            <Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-66666615"/>

            </Transforms>

            <DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>

            <DigestValue>xFzhgdgnhjSD1e9uqe04lnoHT4ZzLSY=</DigestValue>

            </Reference>

            </SignedInfo>

            <SignatureValue>

            Iz5Z3PLQbzZt9jnBtr6xsmHZMOu/3plXG9xxfFjRCQYGnD1rjlhzBGrqt026Ca2VHHM/bHNepi6FuFkAi595GScKVuHREUotzifE2OIjgavvTOrMwbXG7+0LYgkwPFiPCao2S33UpZe7MneaxcmKQGKQZw1fP8fsWmaQ4cczZT8=

            </SignatureValue>

            <KeyInfo>

            <X509Data>

            <X509Certificate>

            MIIEuzCCA6OgAwIBAgIDMTMxMA0GasfFSDAGQUAMIGSMQswCQYDVQQGEwJCUjELMAkGA1UECBMCUlMxFTATBgNVBAcTDFBvcnRvIEFsZWdyZTEdMBsGA1UEChMUVGVzdGUgUHJvamV0byBORmUgUlMxHTAbBgNVBAsTFFRlc3RlIFByb2pldG8gTkZlIFJTMSEwHwYDVQQDExhORmUgLSBBQyBJbnRlcm1lZGlhcmlhIDEwHhcNMDgwNDI4MDkwMTAyWhcNMDkwNDMwMjM1OTU5WjCBnjELMAkGA1UECBMCUlMxHTAfvw4567DRhg76FByb2pldG8gTkZlIFJTMR0wGwYDVQQKExRUZXN0ZSBQcm9qZXRvIE5GZSBSUzEVMBMGA1UEBxMMUE9SVE8gQUxFR1JFMQswCQYDVQQGEwJCUjEtMCsGA1UEAxMkTkZlIC0gQXNzb2NpYWNhbyBORi1lOjk5OTk5MDkwOTEwMjcwMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDDh6RRv0bj4RYX+tDQrZRb5opa77LBVVs+6LphIfSF3TSWPfnKh0+xLlBFdmnB5YGgbbW9Uon6pZQTfaC8jZhRhI5eFRRofY/Ugoeo0NGt6PcIQNZQd6lLQ/ASd1qWwjqJoEa7udriKjy3h351Mf1bng1VxS1urqC3Dn39ZWIEwQIDAQABo4IBjjCCAYowIgYDVR0jAQEABBgwFoAUPT5TqhNWAm+ZpcVsvB7malDBjEQwDwYDVR0TAQH/BAUwAwEBADAPBgNVHQ8BAf8EBQMDAOAAMAwGA1UdIAEBAAQCMAAwgbwGA1UdEQEBAASBsTCBrqA4BgVgTAEDBKAvBC0wNzA4MTk1MTE1MTk0NTMxMDg3MDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDCgHQYFYEwBAwKgFAQSRmVybmFuZG8gQ2FudG8gQWx0oBkGBWBMAQMDoBAEDjk5OTk5MDkwOTEwMjcwoBcGBWBMAQMHoA4EDDAwMDAwMDAwMDAwMIEfZmVybmFuZG8tYWx0QHByb2NlcmdzLnJzLmdvdi5icjAgBgNVHSUBAf8EFjAUBggrBgEFBQcDAgYIKwYBBQUHAwQwUwYDVR0fAQEABEkwRzBFoEOgQYY/aHR0cDovL25mZWNlcnRpZmljYWRvLnNlZmF6LnJzLmdvdi5ici9MQ1IvQUNJbnRlcm1lZGlhcmlhMzguY3JsMA0GCSqGSIb3DQEBBQUAA4IBAQCNPpaZ3Byu3/70nObXE8NiM53j1ddIFXsb+v2ghCVd4ffExv3hYc+/a3lfgV8H/WfQsdSCTzS2cHrd4Aasr/eXfclVDmf2hcWz+R7iysOHuT6B6r+DvV3JcMdJJCDdynR5REa+zViMnVZo1G3KuceQ7/y5X3WFNVq4kwHvonJ9oExsWyw8rTwUK5bsjz0A2yEwXkmkJIngnF41sP31+9jCImiqkXcmsesFhxzX7iurAQAQCZOm7iwMWxQKcAjXCZrgSZWRQy6mU224sX3HTArHahmLJ9Iw+WYAua5qBJsiN6PC7v5tfhdsgGD46DHMnOecxvkkPolDUyBa7d7xwgm

            </X509Certificate>

            </X509Data>

            </KeyInfo>

            </Signature>

            </NFe>'
        courier:
          type:
          - string
          - 'null'
          description: The name of the carrier responsible for delivering the order. *This field should only be used when sending the **tracking** information. When the request is used for sending the invoice, this field should be left empty (`""`)*.
          example: carrierOne
        trackingNumber:
          type:
          - string
          - 'null'
          description: The number code that identifies the order tracking. *This field should only be used when sending the **tracking** information. When the request is used for sending the invoice, this field should be left empty (`""`)*.
          example: '87658'
        trackingUrl:
          type:
          - string
          - 'null'
          description: The URL used to track the order. *This field should only be used when sending the **tracking** information. When the request is used for sending the invoice, this field should be left empty (`""`)*.
          example: https://www.tracking.com/url
        dispatchedDate:
          type:
          - string
          - 'null'
          description: Order dispatch date. May be `null`.
          example: '2019-02-08T13:16:13.4617653+00:00'
        items:
          type: array
          items:
            $ref: '#/components/schemas/Item1'
          description: Array containing the SKUs that are being invoiced.
      example:
        type: Output
        issuanceDate: 2019-01-302019-01-31T18:25:43-05:00
        invoiceNumber: '9999'
        invoiceValue: '10000'
        invoiceKey: null
        invoiceUrl: null
        courier: null
        trackingNumber: null
        trackingUrl: null
        dispatchedDate: '2019-01-31T18:25:43-05:00'
        items:
        - id: '1234'
          price: 10000
          quantity: 1
    Item1_2:
      title: Item1
      required:
      - itemIndex
      - price
      - quantity
      type: object
      properties:
        itemIndex:
          type: string
          description: Index of the SKU being invoiced.
          example: 67
        price:
          type: integer
          format: int32
          description: Total price of the SKU being invoiced in cents. Do not use any decimal separator. For instance, `$24.99` should be represented as `2499`.
          example: 2499
        quantity:
          type: integer
          format: int32
          description: Quantity cof the SKU being invoiced.
          example: 3
      example:
        id: '1234'
        price: 10000
        quantity: 1
    InvoiceNotificationRequest_2:
      title: InvoiceNotificationRequest
      required:
      - type
      - issuedDate
      - invoiceNumber
      - invoiceValue
      - items
      type: object
      properties:
        type:
          type: string
          description: 'The type of invoice. There are two possible values: `"Output"` and `"Input"`. The `"Output"` type should be used when the invoice you are sending is a selling invoice. The `"Input"` type should be used when you send a return invoice.'
          example: Output
        issuedDate:
          type: string
          description: Issuance date of the invoice in ISO format.
          example: '2020-07-15'
        invoiceNumber:
          type: string
          description: Number that identifies the invoice.
          example: '123456789'
        invoiceValue:
          type: string
          description: Total amount being invoiced in cents. Do not use any decimal separator. For instance, `$24.99` should be represented as `2499`.
          example: 2499
        extraValue:
          type: integer
          description: Extra value in the invoice in cents. Do not use any decimal separator. For instance, `$24.99` should be represented as `2499`.
          example: 100
        invoiceKey:
          type:
          - string
          - 'null'
          description: Invoice key.
        invoiceUrl:
          type: string
          descriptio

# --- truncated at 32 KB (34 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vtex/refs/heads/main/openapi/vtex-invoice-api-openapi.yml