DT - Imputar Transação de Devolução através da API General.

01. DADOS GERAIS

02. SITUAÇÃO/REQUISITO

Inclusão de transação de Devolução no TOTVS Moda via API General permitindo fazer o referenciamento entre as notas fiscais de origem e devolução.

03. SOLUÇÃO

Inclusão da transação de Devolução com Nota Fiscal Referencial

• Utilizar na API General (  https://apitotvsmoda.bhan.com.br/api/totvsmoda/general/v2/swagger/index.html   )  o endpoint de Incluir transação (/api/totvsmoda/general/v2/transactions) para fazer este impute de transação.
• Para inclusão respeitando as operações fiscais deverá informar nos campos as informações pertinentes a devolução, são elas: 
  • Código da operação de devolução já configurada no TOTVS Moda no campo:
    • "operationCode" - 

• • Nota fiscal referencial (nota fiscal de saída da origem, pode ser de venda, transferência, etc...) o item a ser devolvido para que o TOTVS Moda possa validar e permitir a inclusão e referenciamento na emissão da nota fiscal de devolução, para isto utilizar a opção de  "returnItems" dentro de item, lembrando este campo é um Array, para os casos que a quantidade devolvida é maior que um do item e possuir mais de uma nota fiscal de saída da origem.
    •  "items": [
      "returnItems": [
                      {                     "branchCode": 0,
                                            "invoiceDate": "2025-06-16",
                                            "invoiceNumber": 0,                    
                                            "quantity": 0,
                                            "sequence": 0 
                     }
                  ]
          ]

Segue exemplo no nosso ambiente interno:

• URL Utilizada para inclusão da transação.
  • {     "totalAmountTransaction": 299,
          "branchCode": 1,
          "customerCode": 9157,
          "transactionDate": "2025-07-07",
          "status": 1,
          "paymentConditionCode": 1,
          "operationCode": 5052,
          "sellerCode": 50,
          "componentCode": "TRAFP086",
          "items": [ {
                              "quantity": 1,
                              "value": 299,
                              "productCode": 12,
                              "descriptionProduct": "BLUSA CRIATIVA 70100",
                              "sellerCode": 50,
                              "returnItems": [                 
                               {                     "branchCode": 1,
                                                     "invoiceDate": "2025-06-16",
                                                     "invoiceNumber": 796348,
                                                     "quantity": 1,
                                                     "sequence": 1
                                }

                ]
    }
     

• Operação já cadastrada no TOTVS Moda:
  • 
• Nota fiscal de venda.
  • 
• Transação atendida dentro do TOTVS Moda após a inclusão, com a referencia a nota fiscal de venda conforme enviada via integração.
  • 

Observação final:

• Para atender as regras fiscais deverá:
  • cadastrar as operações corretamente dentro do TOTVS Moda.
  • Enviar o relacionamento da nota fiscal de saída corretamente, caso não tenha informação utilizar a consulta de nota fiscal existente na API Fiscal ( https://apitotvsmoda.bhan.com.br/api/totvsmoda/fiscal/v2/swagger/index.html  ) com o Endpoint Obter lista de notas fiscais e seus dados por filtro geral. (api/totvsmoda/fiscal/v2/invoices/search)
  • Após o input da transação utilizar os processos do TOTVS Moda para encerramento da mesma.