GetSupplierDocuments

Endpoint

Overview

The "GetSupplierDocuments" endpoint is a GET request. It is used to get the supplier documents. Detailed functionality of how to use this endpoint is explained in the Multiple Suppliers section.

The endpoint on Swagger is Supplier_GetSupplierDocuments.

Now, we are going to declare the endpoint and its models along with each accepted parameter and possible value.

📘

Request Header

Add "Authorization": "Bearer {Token}" to request header. Token of demo configuration can be found here.


Request Model

The request is a GET request with the following parameters:

Input Parameter

Type

Description

SupplierCode

integer


Response Model

The response is an array of SupplierFileView objects as follows:

Response Field

Type

Description

FileUrl

string

The document URL.

FileType

integer

It can be in ['1', '2', '3', '4', '5', '6', '7']

FileTypeName

string

It can be:
Commercial License, Signature Authorisation, Articles of Association, Civil Id, Civil Id Back, 3-parties contract/ agreement, and Others.

ExpireDate

string


Sample Message

/v2/GetSupplierDocuments?SupplierCode=69
[
    {
        "FileUrl": "https://mfstoragemedia.blob.core.windows.net/mfdmfiles/Files/Suppliers/3-ArticlesOfAssociation.pdf",
        "FileType": 3,
        "FileTypeName": "Articles of Association",
        "ExpireDate": null
    },
    {
        "FileUrl": null,
        "FileType": 1,
        "FileTypeName": "Commercial License",
        "ExpireDate": null
    },
    {
        "FileUrl": null,
        "FileType": 2,
        "FileTypeName": "Signature Authorisation",
        "ExpireDate": null
    },
    {
        "FileUrl": null,
        "FileType": 4,
        "FileTypeName": "Civil Id",
        "ExpireDate": null
    },
    {
        "FileUrl": null,
        "FileType": 5,
        "FileTypeName": "Civil Id Back",
        "ExpireDate": null
    },
    {
        "FileUrl": null,
        "FileType": 6,
        "FileTypeName": "3-parties contract/ agreement",
        "ExpireDate": null
    },
    {
        "FileUrl": null,
        "FileType": 7,
        "FileTypeName": "Others",
        "ExpireDate": null
    }
]


Did this page help you?