CRcrunchtime
Pbi Service

getAttachmentsByPageV2

Changed on

Retrieves purchase by invoice records with the accompanying information (by page).

get/pbi/v2/getAttachmentsByPage

Request

  • Base URL
    //webservices-test.net-chef.com (relative, and the document’s source URL is not known)
  • URL
    //webservices-test.net-chef.com/pbi/v2/getAttachmentsByPage
  • Auth
    none declared. Required headers: authenticationtoken, password, sitename, userid

Query parameters

locationCodestring

Code for the Location to retrieve. Required if minutesSinceUpdate or one of vendorCode, or vendorInvoiceNumber is not provided.

vendorCodestring

Code for the Vendor to retrieve. Required if minutesSinceUpdate or one of locationCode or vendorInvoiceNumber is not provided.

vendorInvoiceNumberstring

Vendor Invoice Number to retrieve. Required if minutesSinceUpdate or one of locationCode or vendorCode is not provided.

minutesSinceUpdateinteger

The number of minutes since the file was uploaded. Use to set how far back to search. Required if one of locationCode, vendorInvoiceNumber, or vendorCode is not provided.

sortBy'fileName' | 'fileDescription' | 'fileSize' | 'uploadDate' | 'vendorInvoiceNumber'

Specifies the field to sort the attachments by. Default field 'fileName' (optional).

sortOrder'ASC' | 'DESC'

Specifies record sort order in ascending (ASC) or descending (DESC) direction, Default ASC.(Optional).

pageNumberinteger

Retrieve one or more records by pageNumber. \n Use to retrieve data in smaller chunks. \n If left blank, the default is 1.

traceabilityCodestring

Retrieve orders where the Traceability Code in the details matches the value provided (optional).

pageSizeinteger

Number of items to display per page.

includeNullboolean

Specify 'true' to include null data elements in the output.

Headers

authenticationtokenstring required

Secure token for API authentication.

passwordstring required

Password for the Crunchtime Application User.

sitenamestring required

Crunchtime site identifier. (test or production)

useridstring required

"User ID for the Crunchtime Application User.

X-B3-TraceIdstring

Optional trace identifier for troubleshooting.

Response

Success

totalPagesinteger
hasNextboolean

Example response

{
  "attachments": [
    {
      "locationCode": "LOC123",
      "fileName": "IMG_6717.JPG",
      "fileDescription": "Delivery photo",
      "fileSize": 20,
      "fileUrl": "https://download.net-chef.com/attachment",
      "vendorCode": "KATSIR",
      "locationExportCode": "0409",
      "vendorExportCode": "VREIN15",
      "uploadDate": "05/25/2021 08:11:18"
    }
  ]
}

Changes