API para alteração de Itens dos Documentos

Esse endpoint permite, através de um PATCH HTTP, alteração de informações dos documentos.

fetch("http://SERVER:PORT/api/invoiceproduct", {
  method: "PATCH",
  body: 
    [
        {
            "invoice": "T1",
            "productReference": "P1",
            "quantity": 1,
            "custom": {
                "custom1": "valor1",
                "custom2": 1
            },
            "fraction": 1.1,
            "externalId": "123",
            "batch": "123",
            "type": "PRODUCED",
            "packingQuantity": 1,
        },
        {
            "invoice": "INVOICE2",
            "productReference": "P2",
        }
    ],
  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á instalado
• PORT - A porta definida na instalação do sistema.

Campos do corpo da requisição:

• invoice - Código de referencia do documento pai(Obrigatório)
• productReference - Código de referencia do produto(Obrigatório)
• quantity - Quantidade do produto no documento
• custom - Campos customizados conforme cadastro no sistema
• fraction - Fração referente ao item
• externalId - Identificação externa
• batch - Lote do item
• type - Tipo do produto
  • PRODUCED - Produto Acabado
  • RAW - Material
  • CONTAINER - Armazenagem
  • FIXED_ASSET - Ativo Imobilizado
• packingQuantity - Total do packing do item

Resposta em caso de sucesso

{
	"invoiceProducts": [
		{
			"id": "3554a08c-a368-45bc-8088-6cc70a6b6c94",
			"createdAt": "2024-07-13 14:57:46.403",
			"createdBy": "valesoft",
			"updatedAt": "2024-07-15 14:05:30.662",
			"updatedBy": "valesoft",
			"custom": {
				"i1": "pudim",
				"i2": 1
			},
			"integrated": false,
			"invoice": {
				"id": "d0a79ea1-e879-4608-927b-08964190d9f7",
				"createdAt": "2024-07-13 08:47:06.355",
				"createdBy": "valesoft",
				"updatedAt": "2024-07-13 14:46:41.655",
				"updatedBy": "valesoft",
				"custom": {
					"teste1": "te",
					"teste2": 2
				},
				"integrated": false,
				"reference": "T1",
				"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
			},
			"productReference": {
				"id": "350bebb1-0d7e-45d6-993b-738baeabba51",
				"createdAt": "2024-07-13 14:57:20.840",
				"createdBy": "valesoft",
				"updatedAt": "2024-07-13 14:57:20.841",
				"updatedBy": "valesoft",
				"product": {
					"id": "7a02d239-1c17-4333-a296-6f9ba6ee45ca",
					"createdAt": "2024-07-13 14:57:20.715",
					"createdBy": "valesoft",
					"updatedAt": "2024-07-13 14:57:20.715",
					"updatedBy": "valesoft",
					"custom": null,
					"integrated": false,
					"sku": "123",
					"description": "Teste",
					"barcode": null,
					"measureUnit": null,
					"fraction": null,
					"type": "PRODUCED",
					"place": null,
					"averageCost": null,
					"externalId": null,
					"color": null,
					"size": null,
					"costCenter": null
				},
				"productGrid": null,
				"sku": "123",
				"description": "123 - Teste",
				"color": null,
				"size": null,
				"measureUnit": null,
				"barcode": null,
				"fraction": null,
				"type": "PRODUCED",
				"externalId": null
			},
			"type": "PRODUCED",
			"batch": null,
			"quantity": 1,
			"fraction": 0.0,
			"packingQuantity": null,
			"externalId": null
		}
	],
	"error": {}
}

Resposta em caso de erro

{
	"invoiceProducts": [],
	"error": {
      "invoice - product": "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