Delivery Note Internal

AI Pedant Document Service API (proto file)

This document describes the gRPC API defined in the document_service.proto file for document-related internal communication functionalities.

Dependencies

google/protobuf/empty.proto: Used for empty response messages.

Services

The DeliveryNoteInternalService offers gRPC methods for updating delivery notes.

Functions:

UpdateDN: Updates a delivery note with the provided information.

Messages

UpdateDNRequest:

deliveryDate: Delivery date.
deliveryNumber: Delivery number.
customerNumber: Customer number.
orderNumber: Order number.
orderDate: Order date.
recipientInfo: Recipient information.
recipientName: Recipient name.
recipientAddress: Recipient address.
vendorInfo: Vendor information.
vendorName: Vendor name.
vendorAddress: Vendor address.
costCenter: Cost center.
subsequent: Subsequent cost.
status: Status of the delivery note.

DNStatus:

processing: Delivery note is being processed.
failed: Delivery note processing failed.
uploaded: Delivery note has been uploaded.
reviewed: Delivery note has been reviewed.
exported: Delivery note has been exported.
rejected: Delivery note has been rejected.
archived: Delivery note has been archived.

Proto Definition (Markdown format)

syntax = "proto3";

package ai.pedant.srv.document;

option java_package = "ai.pedant.srv.document";
option go_package = "pedant.ai/pedant-document-service/grpc-gateway";

import "google/protobuf/empty.proto";

service DeliveryNoteInternalService {
    rpc UpdateDN(UpdateDNRequest) returns (google.protobuf.Empty) {}
}

message UpdateDNRequest {
    string deliveryDate = 1;
    string deliveryNumber = 2;
    string customerNumber = 3;
    string orderNumber = 4;
    string orderDate = 5;
    string recipientInfo = 6;
    string recipientName = 7;
    string recipientAddress = 8;
    string vendorInfo = 9;
    string vendorName = 10;
    string vendorAddress = 11;
    float costCenter = 12;
    float subsequent = 13;
    enum DNStatus {
        processing = 0;
        failed = 1;
        uploaded = 2;
        reviewed = 3;
        exported = 4;
        rejected = 5;
        archived = 6;
    }
    DNStatus status = 14;
}

Last modified: 20 October 2024