GET servico/integracaoterceiros/ConsultarDocumentoPorChaveFato/{chaveDeFato}

Obter o Documento pela Chave de Fato

Request Info

URI Parameters

NomeDescriçãoTipoInformações adicionais
chaveDeFato

Chave de Fato de Documento

 string

Required

Body Parameters

None.

Response Info

Resource Description

DTORetornoDocumentoPorChaveFato
NomeDescriçãoTipoInformações adicionais
IDDoPerfilTMV

Perfil do tipo de movimento.

 string

None.
IDDaFilial

ID da filial.

 string

None.
IDDaFilialDeTerceiro

ID da filial de terceiro.

 string

None.
CodigoSistemaTerceiro

ID do Sistema de Terceiro.

 string

None.
IDDaCondicaoDePagamento

ID da Condição de Pagamento.

 string

None.
DocumentoAtualizado

Situação do status contábil [ S = Sim | N = Não ]

 string

None.
ChaveDeFatoDoDocumento

Id do Documento

 string

None.
ChaveDeFatoOrigem

ID do documento origem.

 string

None.
ChaveDeFatoOrigemDev

ID do documento origem devolução.

 string

None.
ChaveDeFatoRecepcao

ID do documento recepção.

 string

None.
DataDeMovimentacao

Data da movimentação.

 date

None.
DataDeEstoque

Date de estoque

 date

None.
IDDoParticipante

ID do cliente/fornecedor.

 integer

None.
IDDaLinhaDeProducao

ID da linha de produção

 string

None.
TipoDeMovimento

Tipo de movimento do documento (TMV). O mesmo será validado com o perfil informado.

 string

None.
Serie

Série do documento. Se não informada será utilizado a série ativa.

 string

None.
NumeroDoDocumento

Número do documento. Se não informado o sistema pegará a sequência da série ativa.

 integer

None.
NumeroDocumentoAuxiliar

Número do documento auxiliar, para controle de terceiros.

 string

None.
Usuario

Nome do usuário do sistema. tbUsuario.cod_usuario

 string

None.
DataV1

Data variavel 1

 date

None.
DataV2

Data variavel 2

 date

None.
CodigoVendedorComprador

Código do Vendedor Comprador

 integer

None.
CodigoPropriedadeRural

Código do Cadastro da Propriedade Rural

 integer

None.
CodigoTransportador1

Código do Cadastro da Transportadora

 integer

None.
TipoFrete1

Tipo do Frete

 string

None.
Placa1

Placa do veículo

 string

None.
UfPlaca1

Uf da Placa

 string

None.
CodigoMotorista1

Código do Motorista

 integer

None.
Observacao

Observação

 string

None.
CodigoMotivoDeCancelamento

Código do Motivo de Cancelamento

 string

None.
Itens

Itens do documento.

 Collection of DTORetornoDocumentoItemPorChaveFato

None.
ValorFrete

valor total do frete da nota fiscal

 decimal number

None.
ValorDesconto

valor total de desconto aplicado na nota fiscal

 decimal number

None.
ValorTotal

valor total

 decimal number

None.
ValorLiquido

valor líquido

 decimal number

None.
StatusNFe

situação da NF-e no momento do envio (exemplo: “Autorizada”, “Cancelada”, “Denegada”)

 string

None.
IdDoResponsavel

string

None.

Response Formats

application/json, text/json

Exemplo: 
{
  "IDDoPerfilTMV": "sample string 1",
  "IDDaFilial": "sample string 2",
  "IDDaFilialDeTerceiro": "sample string 3",
  "CodigoSistemaTerceiro": "sample string 4",
  "IDDaCondicaoDePagamento": "sample string 5",
  "DocumentoAtualizado": "sample string 6",
  "ChaveDeFatoDoDocumento": "sample string 7",
  "ChaveDeFatoOrigem": "sample string 8",
  "ChaveDeFatoOrigemDev": "sample string 9",
  "ChaveDeFatoRecepcao": "sample string 10",
  "DataDeMovimentacao": "2026-04-05T10:32:32.1252283-03:00",
  "DataDeEstoque": "2026-04-05T10:32:32.1252283-03:00",
  "IDDoParticipante": 1,
  "IDDaLinhaDeProducao": "sample string 13",
  "TipoDeMovimento": "sample string 14",
  "Serie": "sample string 15",
  "NumeroDoDocumento": 1,
  "NumeroDocumentoAuxiliar": "sample string 16",
  "Usuario": "sample string 17",
  "DataV1": "2026-04-05T10:32:32.1252283-03:00",
  "DataV2": "2026-04-05T10:32:32.1252283-03:00",
  "CodigoVendedorComprador": 1,
  "CodigoPropriedadeRural": 1,
  "CodigoTransportador1": 1,
  "TipoFrete1": "sample string 18",
  "Placa1": "sample string 19",
  "UfPlaca1": "sample string 20",
  "CodigoMotorista1": 1,
  "Observacao": "sample string 21",
  "CodigoMotivoDeCancelamento": "sample string 22",
  "Itens": [
    {
      "IDDoItem": "sample string 1",
      "IDDaRef": "sample string 2",
      "IDDoLocalDeEstoque": "sample string 3",
      "IDDoCentroDeCusto": 1,
      "QuantidadePrimaria": 4.0,
      "IDDaUnidade": "sample string 5",
      "QuantidadeAuxiliar": 6.0,
      "AtualizaSaldoPri": "sample string 7",
      "AtualizaSaldoAux": "sample string 8",
      "PesoLiquido": 1.0,
      "PesoBruto": 1.0,
      "NumeroDoLote": "sample string 9",
      "ValorUnitCustoRCPE": 1.0,
      "ValorUnitario": 10.0,
      "ValorFrete": 11.0,
      "ValorDesconto": 12.0,
      "ValorImposto": 13.0,
      "CodigoCfop": "sample string 14",
      "Observacao": "sample string 15",
      "CodigoSistemaAntigo": "sample string 16",
      "ValorLiquido": 17.0,
      "ValorTotal": 18.0,
      "CodigoSituacaoTributariaICMS": "sample string 19",
      "CodigoSituacaoTributariaIPI": "sample string 20",
      "CodigoSituacaoTributariaPIS": "sample string 21",
      "CodigoSituacaoTributariaCOFINS": "sample string 22"
    },
    {
      "IDDoItem": "sample string 1",
      "IDDaRef": "sample string 2",
      "IDDoLocalDeEstoque": "sample string 3",
      "IDDoCentroDeCusto": 1,
      "QuantidadePrimaria": 4.0,
      "IDDaUnidade": "sample string 5",
      "QuantidadeAuxiliar": 6.0,
      "AtualizaSaldoPri": "sample string 7",
      "AtualizaSaldoAux": "sample string 8",
      "PesoLiquido": 1.0,
      "PesoBruto": 1.0,
      "NumeroDoLote": "sample string 9",
      "ValorUnitCustoRCPE": 1.0,
      "ValorUnitario": 10.0,
      "ValorFrete": 11.0,
      "ValorDesconto": 12.0,
      "ValorImposto": 13.0,
      "CodigoCfop": "sample string 14",
      "Observacao": "sample string 15",
      "CodigoSistemaAntigo": "sample string 16",
      "ValorLiquido": 17.0,
      "ValorTotal": 18.0,
      "CodigoSituacaoTributariaICMS": "sample string 19",
      "CodigoSituacaoTributariaIPI": "sample string 20",
      "CodigoSituacaoTributariaPIS": "sample string 21",
      "CodigoSituacaoTributariaCOFINS": "sample string 22"
    }
  ],
  "ValorFrete": 23.0,
  "ValorDesconto": 24.0,
  "ValorTotal": 25.0,
  "ValorLiquido": 26.0,
  "StatusNFe": "sample string 27",
  "IdDoResponsavel": "sample string 28"
}

application/xml, text/xml

Exemplo: 
<DTORetornoDocumentoPorChaveFato xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATAK.DTO.MovimentacaoDeEntradaESaida.IntegracaoDeTerceiros">
  <ChaveDeFatoDoDocumento>sample string 7</ChaveDeFatoDoDocumento>
  <ChaveDeFatoOrigem>sample string 8</ChaveDeFatoOrigem>
  <ChaveDeFatoOrigemDev>sample string 9</ChaveDeFatoOrigemDev>
  <ChaveDeFatoRecepcao>sample string 10</ChaveDeFatoRecepcao>
  <CodigoMotivoDeCancelamento>sample string 22</CodigoMotivoDeCancelamento>
  <CodigoMotorista1>1</CodigoMotorista1>
  <CodigoPropriedadeRural>1</CodigoPropriedadeRural>
  <CodigoSistemaTerceiro>sample string 4</CodigoSistemaTerceiro>
  <CodigoTransportador1>1</CodigoTransportador1>
  <CodigoVendedorComprador>1</CodigoVendedorComprador>
  <DataDeEstoque>2026-04-05T10:32:32.1252283-03:00</DataDeEstoque>
  <DataDeMovimentacao>2026-04-05T10:32:32.1252283-03:00</DataDeMovimentacao>
  <DataV1>2026-04-05T10:32:32.1252283-03:00</DataV1>
  <DataV2>2026-04-05T10:32:32.1252283-03:00</DataV2>
  <DocumentoAtualizado>sample string 6</DocumentoAtualizado>
  <IDDaCondicaoDePagamento>sample string 5</IDDaCondicaoDePagamento>
  <IDDaFilial>sample string 2</IDDaFilial>
  <IDDaFilialDeTerceiro>sample string 3</IDDaFilialDeTerceiro>
  <IDDaLinhaDeProducao>sample string 13</IDDaLinhaDeProducao>
  <IDDoParticipante>1</IDDoParticipante>
  <IDDoPerfilTMV>sample string 1</IDDoPerfilTMV>
  <IdDoResponsavel>sample string 28</IdDoResponsavel>
  <Itens>
    <DTORetornoDocumentoItemPorChaveFato>
      <AtualizaSaldoAux>sample string 8</AtualizaSaldoAux>
      <AtualizaSaldoPri>sample string 7</AtualizaSaldoPri>
      <CodigoCfop>sample string 14</CodigoCfop>
      <CodigoSistemaAntigo>sample string 16</CodigoSistemaAntigo>
      <CodigoSituacaoTributariaCOFINS>sample string 22</CodigoSituacaoTributariaCOFINS>
      <CodigoSituacaoTributariaICMS>sample string 19</CodigoSituacaoTributariaICMS>
      <CodigoSituacaoTributariaIPI>sample string 20</CodigoSituacaoTributariaIPI>
      <CodigoSituacaoTributariaPIS>sample string 21</CodigoSituacaoTributariaPIS>
      <IDDaRef>sample string 2</IDDaRef>
      <IDDaUnidade>sample string 5</IDDaUnidade>
      <IDDoCentroDeCusto>1</IDDoCentroDeCusto>
      <IDDoItem>sample string 1</IDDoItem>
      <IDDoLocalDeEstoque>sample string 3</IDDoLocalDeEstoque>
      <NumeroDoLote>sample string 9</NumeroDoLote>
      <Observacao>sample string 15</Observacao>
      <PesoBruto>1</PesoBruto>
      <PesoLiquido>1</PesoLiquido>
      <QuantidadeAuxiliar>6</QuantidadeAuxiliar>
      <QuantidadePrimaria>4</QuantidadePrimaria>
      <ValorDesconto>12</ValorDesconto>
      <ValorFrete>11</ValorFrete>
      <ValorImposto>13</ValorImposto>
      <ValorLiquido>17</ValorLiquido>
      <ValorTotal>18</ValorTotal>
      <ValorUnitCustoRCPE>1</ValorUnitCustoRCPE>
      <ValorUnitario>10</ValorUnitario>
    </DTORetornoDocumentoItemPorChaveFato>
    <DTORetornoDocumentoItemPorChaveFato>
      <AtualizaSaldoAux>sample string 8</AtualizaSaldoAux>
      <AtualizaSaldoPri>sample string 7</AtualizaSaldoPri>
      <CodigoCfop>sample string 14</CodigoCfop>
      <CodigoSistemaAntigo>sample string 16</CodigoSistemaAntigo>
      <CodigoSituacaoTributariaCOFINS>sample string 22</CodigoSituacaoTributariaCOFINS>
      <CodigoSituacaoTributariaICMS>sample string 19</CodigoSituacaoTributariaICMS>
      <CodigoSituacaoTributariaIPI>sample string 20</CodigoSituacaoTributariaIPI>
      <CodigoSituacaoTributariaPIS>sample string 21</CodigoSituacaoTributariaPIS>
      <IDDaRef>sample string 2</IDDaRef>
      <IDDaUnidade>sample string 5</IDDaUnidade>
      <IDDoCentroDeCusto>1</IDDoCentroDeCusto>
      <IDDoItem>sample string 1</IDDoItem>
      <IDDoLocalDeEstoque>sample string 3</IDDoLocalDeEstoque>
      <NumeroDoLote>sample string 9</NumeroDoLote>
      <Observacao>sample string 15</Observacao>
      <PesoBruto>1</PesoBruto>
      <PesoLiquido>1</PesoLiquido>
      <QuantidadeAuxiliar>6</QuantidadeAuxiliar>
      <QuantidadePrimaria>4</QuantidadePrimaria>
      <ValorDesconto>12</ValorDesconto>
      <ValorFrete>11</ValorFrete>
      <ValorImposto>13</ValorImposto>
      <ValorLiquido>17</ValorLiquido>
      <ValorTotal>18</ValorTotal>
      <ValorUnitCustoRCPE>1</ValorUnitCustoRCPE>
      <ValorUnitario>10</ValorUnitario>
    </DTORetornoDocumentoItemPorChaveFato>
  </Itens>
  <NumeroDoDocumento>1</NumeroDoDocumento>
  <NumeroDocumentoAuxiliar>sample string 16</NumeroDocumentoAuxiliar>
  <Observacao>sample string 21</Observacao>
  <Placa1>sample string 19</Placa1>
  <Serie>sample string 15</Serie>
  <StatusNFe>sample string 27</StatusNFe>
  <TipoDeMovimento>sample string 14</TipoDeMovimento>
  <TipoFrete1>sample string 18</TipoFrete1>
  <UfPlaca1>sample string 20</UfPlaca1>
  <Usuario>sample string 17</Usuario>
  <ValorDesconto>24</ValorDesconto>
  <ValorFrete>23</ValorFrete>
  <ValorLiquido>26</ValorLiquido>
  <ValorTotal>25</ValorTotal>
</DTORetornoDocumentoPorChaveFato>