Pennylane API Client
    Preparing search index...

    Variable FileAttachmentsApiConst

    FileAttachmentsApi: {
        uploadFileAttachment: (
            body: UploadFileAttachmentBody,
        ) => Effect<
            {
                created_at: string;
                filename: string;
                id: number;
                updated_at: string;
                url: string;
            },
            UploadFileAttachmentError,
            PennylaneClient,
        >;
    } = ...

    Service containing methods for the "file_attachments" endpoints.

    Type Declaration

    • uploadFileAttachment: (
          body: UploadFileAttachmentBody,
      ) => Effect<
          {
              created_at: string;
              filename: string;
              id: number;
              updated_at: string;
              url: string;
          },
          UploadFileAttachmentError,
          PennylaneClient,
      >

      Uploads a file (max 100MB) and returns a file attachment.

      The returned id can be used as file_attachment_id, for example to import a supplier invoice that will then be matched to a bank transaction. The file is not added to the Pennylane DMS (GED).

      Possible errors:

      • UploadFileAttachmentBadRequest (400): Missing or invalid file
      • UploadFileAttachmentUnauthorized (401): Invalid or missing API key
      • UploadFileAttachmentForbidden (403): Insufficient permissions for this operation
      • UploadFileAttachmentNotFound (404): Resource not found
      • UploadFileAttachmentUnprocessableEntity (422): Upload rejected by business validation