Nota Fiscal de Saida (Invoice)
evandrodeliberal edited this page May 3, 2022
·
3 revisions
A nota fiscal de saída é um instrumento importante, por se tratar de uma formalização quanto a saída do produto e permitir gerar uma expedição.
Objetivo / Goals: Incluir uma nota fiscal de Saída / Send a invoice
Endereço / Endpoint: https://api2.monitor360.com.br/awmaterial/v2/nfs
Método / Method: POST
Conteúdo a ser enviado / Payload
- ambiente: Nome do ambiente do qual o cliente esta utilizando (Obrigatório) / Name of ambient that yout client is used (Required)
- nota:
- idEmp: Código da Empresa do qual a nota pertence (Obrigatório) - Integer / Company ID that this invoice will be able (Required) - Integer
- nrNota: Numero da Nota fiscal (Obrigatório) - String / Invoice Number (Required) - String
- serie: Serie da Nota fiscal (Obrigatório) - String / Invoice Serie (Required) - String
- idCliente: Código do Cliente (Obrigatório) - Integer/ Client ID (Required) - String
- nrEmbarque: Numero do Embarque da Nota - String / Boarding Number - String
- nrPedido: Numero do Pedido de Venda (Obrigatório) - String / Order Number (Required) - String
- daFaturamento: Data em que a nota foi Faturada (Obrigatório) - Date/ Invoice Date (Required) - String
- daEmissao: Data de emissão da Nota (Obrigatório) - Datw/ Invoice Date Emission (Required) - String
- naturOperacao: Natureza de Operação (Obrigatório) - String / Operation Nature (Required) - String
- chaveNfe: Chave da Nota fiscal (Obrigatório) - String / Invoice Key (Required) - String
- daAutNfe: Data da autorização da Nota - Date/ Invoice Key Date (Required) - String
- vlTotalNf: Valor total da Nota (Obrigatório) - Decimal/ Total value Invoice - Decimal
- vlIpi: Valor Total de IPI (Obrigatório) - Decimal/ Total IPI Value Invoice - Decimal
- vlIcms: Valor Total de ICMS (Obrigatório) - Decimal/ Total ICMS Value Invoice - Decimal
- itemNota:
- seq: Sequencia do Item na Nota (Obrigatório) - integer/ Item sequence into Invoice (Required) - String
- idProduto: Id do Produto (Obrigatório) - String / Product ID (Required) - String
- descProduto: Descrição do Produto (Obrigatório) - String / Product Description (Required) - String
- unMedida: Unidade de Medida do Produto (Obrigatório) - String / Unit of measurement (Required) - String
- quantidade: Quantidade do Item (Obrigatório) - String / Amount (Required) - String
- vlUnit: Valor Unitário (Obrigatório) - String / Unit Value (Required) - String
- vlTotal: Valor Total (Obrigatório) - String / Total Value (Required) - String
- vlIpi: Valor do IPI (Obrigatório) - String / IPI Value (Required) - String
- vlIcms: Valor do ICMS (Obrigatório) - String / ICMS Value (Required) - String
- naturOperacaoIt: Natureza de Operação do Item (Obrigatório) - String / Operation Nature of Product (Required) - String
- obs: Observação - String / Observation - String
PAYLOAD
` {
"ambiente": "ambiente",
"nota":[
{
"idEmp": 1,
"nrNota":"00074",
"serie":"002",
"idCliente": 2,
"nrEmbarque": 123434,
"nrPedido": "1222200PX",
"daFaturamento": "2021-07-01",
"daEmissao": "2021-07-01",
"naturOperacao": "516FP",
"chaveNfe": "11894739284792840238409324342",
"daAutNfe": "2021-07-01",
"vlTotalNf": 123.22,
"vlIpi": 123.33,
"vlIcms": 123.33,
"itemNota": [
{
"seq": 10,
"idProduto": "PROD1",
"descProduto": "Descrição do Produto",
"unMedida": "UN",
"quantidade": 12.2,
"vlUnit": 12.2,
"vlTotal": 12.2,
"vlIpi": 12.2,
"vlIcms": 12.2,
"naturOperacaoIt": "516FP2",
"obs": "text"
},
{
"seq": 20,
"idProduto": "PROD2",
"descProduto": "Descrição do Produto 2",
"unMedida": "UN",
"quantidade": 12.2,
"vlUnit": 12.2,
"vlTotal": 12.2,
"vlIpi": 12.2,
"vlIcms": 12.2,
"naturOperacaoIt": "516FP2",
"obs": "text"
},
{
"seq": 30,
"idProduto": "PROD3",
"descProduto": "Descrição do Produto 3",
"unMedida": "UN",
"quantidade": 12.2,
"vlUnit": 12.2,
"vlTotal": 12.2,
"vlIpi": 12.2,
"vlIcms": 12.2,
"naturOperacaoIt": "516FP",
"obs": "text"
}
]
}
]
}
`
EXEMPLO DE CHAMADA / CALL EXAMPLE
`
curl --location --request POST 'https://api2.monitor360.com.br/awmaterial/v2/nfs'
--header 'Content-Type: application/json'
--header 'Accept: application/json'
--header 'Authorization: Basic xxxxxxxxxx'
--header 'Cookie: PHPSESSID=otruhu9i5qega7m26kv0d3vc71'
--data-raw ''
`
RETORNO DA API / RESPONSE
`
{ "data": "2021-11-05 20:08:56", "statusCode": 200, "msg": "Gravado com Sucesso" }
`
- data: Data do retorno / Return date
- statusCode: semelhante ao HTTP Status Code, possiveis retorno / Like http status code, possible return:
- 200: Sucesso / Sucess
- 400: Erro no conteudo enviado / Bad Request
- 500: Serviço indisponível / Unvailable
- msg: Descrição ou apoio quando erro 400 / Description or help when status code 400
Objetivo / Goals: Cancelar uma nota fiscal de Saída / Cancel a invoice
Endereço / Endpoint: https://api2.monitor360.com.br/awmaterial/v2/nfs
Método / Method: DELETE
CONTEUDO A SER ENVIADO / PAYLOAD
- ambiente: Nome do ambiente do qual o cliente esta utilizando (Obrigatório) / Name of ambient that yout client is used (Required)
- nota:
- idEmp: Código da Empresa do qual a nota pertence (Obrigatório) - Integer / Company ID that this invoice will be able (Required) - Integer
- nrNota: Numero da Nota fiscal (Obrigatório) - String / Invoice Number (Required) - String
- serie: Serie da Nota fiscal (Obrigatório) - String / Invoice Serie (Required) - String
- idCliente: Código do Cliente (Obrigatório) - Integer/ Client ID (Required) - String
PAYLOAD
`
{ "ambiente": "AMBIENTE", "nota":[ { "idEmp": 1, "nrNota":"00072", "serie":"002", "idCliente": 2 } ] } `
RETORNO DA API / RESPONSE
`
{ "data": "2021-11-05 20:08:56", "statusCode": 200, "msg": "Gravado com Sucesso" }
`
- data: Data do retorno / Return date
- statusCode: semelhante ao HTTP Status Code, possiveis retorno / Like http status code, possible return:
- 200: Sucesso / Sucess
- 400: Erro no conteudo enviado / Bad Request
- 500: Serviço indisponível / Unvailable
- msg: Descrição ou apoio quando erro 400 / Description or help when status code 400