Appearance
API para alteração de Documentos
Esse endpoint permite, através de um PATCH HTTP, alteração de informações dos documentos.
javascript
fetch("http://SERVER:PORT/api/invoice", {
method: "PATCH",
body:
[
{
"invoice": "T1",
"description": "Descrição",
"custom": {
"custom1": "valor1",
"custom2": 1
},
"supplier": "S1",
"flow": "F1",
"reference": "T1",
"date": "2024-01-01",
"externalId": "123",
"type": "PROCESSING",
"batch": "123",
"customer": "C1",
"cloudClient": "C2",
"place": "P1",
"labelID": "11ae0bea-b248-4c2e-b763-cc847b0b4e56",
"approvalStatus": "CREATED",
"costCenter": "C1",
"hasReserve": "true"
},
{
"invoice": "INVOICE2"...
}
],
headers: new Headers({
Authorization: "Basic aW50ZWdyYcOnw6NvOjEyMzQ1Njc4",
"Content-Type": "application/json",
}),
})
.then((response) => response.json())
.then((json) => console.log(json))
.catch((error) => console.log(error));
Parâmetros da URL
SERVER
- O IP ou DNS do servidor onde o sistema Valesoft está instaladoPORT
- A porta definida na instalação do sistema.
Campos do corpo da requisição:
invoice
- Documento que será alterado(Obrigatório)description
- Descrição do documentocustom
- Campos customizados conforme cadastro no sistemasupplier
- Código de referencia do fornecedorflow
- Código de referencia do fluxoreference
- Código de referencia do documento(Atenção, caso está opção for preenchida o código do documento será alterado)date
- Data do documentoexternalId
- Identificação externa`type
- Tipo do documento- PROCESSING - Beneficiamento
- MANUFACTURE - Ordem de produção
- ENTRY - NF Entrada
- OUTGOING - NF Saída
- SALES - Pedido Saída
- CLOUD - Nuvem
- SHIPPING - Remessa
- RAW_REQUEST - Requisição de material
batch
- ` Lote do documentocustomer
- Código de referencia do cliente(Conforme cadastro de fornecedor)cloudClient
- Código de referencia do cliente(Sómente informar caso houver integração valesoft ativa)place
- Código de referencia do locallabelID
- ID da etiqueta utilizada na impressão dos itens do documentoapprovalStatus
- Status de aprovação´- CREATED - Documento criado
- IN_APPROVAL - Documento em aprovação
- APPROVED - Documento aprovado
costCenter
- Código de referencia do centro de custohasReserve
- Indica se o documento possui reserva
Resposta em caso de sucesso
JSON
{
"invoices": [
{
"id": "d0a79ea1-e879-4608-927b-08964190d9f7",
"createdAt": "2024-07-13 08:47:06.355",
"createdBy": "valesoft",
"updatedAt": "2024-07-15 18:14:55.272",
"updatedBy": "valesoft",
"custom": {
"teste1": "te",
"teste2": 2
},
"integrated": false,
"reference": "T2",
"description": "pudim",
"supplier": null,
"cloudClient": null,
"customer": null,
"place": {
"id": "0365bf02-f052-43ff-a7e7-42fc0610268a",
"createdAt": "2024-07-13 08:47:44.481",
"createdBy": "valesoft",
"updatedAt": "2024-07-13 08:47:44.481",
"updatedBy": "valesoft",
"custom": null,
"integrated": false,
"reference": "L1",
"name": "Local1 ",
"address": null,
"localization": null,
"latitude": null,
"longitude": null,
"externalId": null,
"parent": null,
"type": "SECTOR"
},
"flow": null,
"externalId": null,
"type": "PROCESSING",
"date": "2024-07-13",
"batch": null,
"epcIntegrated": false,
"label": null,
"approvalStatus": "CREATED",
"hasReserve": false,
"approvedBy": null,
"approvedAt": null,
"printStatus": null,
"costCenter": null
}
],
"error": {}
}
Resposta em caso de erro
JSON
{
"invoices": [],
"error": {
"invoice": "Mensagem de erro"
}
}
Obs: A chamada para esse endpoint necessita autenticação do tipo Basic
(Base64 encoded) com credenciais de um usuário devidamente cadastrado no sistema Valesoft. Ex: Usuário integração com senha 12345678
integração:12345678
=> Base64 encoded =>aW50ZWdyYcOnw6NvOjEyMzQ1Njc4
- Header de autenticação =>
Authorization: Basic aW50ZWdyYcOnw6NvOjEyMzQ1Njc4
Obs 2: Por convenção na chamada do endpoint de PATCH devem ser informados apenas os campos que serão alterados
Disponível a partir da versão 1.29.89