Skip to main content
Maintenance / Imports

Get Maintenance Imports

This method requires the MaintenanceImports:Get permission to be associated with your role.

GET
/fm/maintenance-imports

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Query Parameters

interface_batch_nostringqueryrequired

Interface Batch No

Maximum string length: 10
Pattern: ^[1-9]{1}[0-9]*$
interface_item_nostringquery

(Optional) Interface Item No

Maximum string length: 10
Pattern: ^[1-9]{1}[0-9]*$
supplier_codestringquery

(Optional) Supplier Code

This field supports the wildcard % operator.

Maximum string length: 16
Pattern: ^[a-zA-Z0-9\-\_\%\@\s]+$
invoice_nostringquery

(Optional) Invoice No

Maximum string length: 20
client_codestringquery

(Optional) Client Code

contract_idstringquery

(Optional) Contract Id

Maximum string length: 10
Pattern: ^[1-9]{1}[0-9]*$
reg_nostringquery

(Optional) Reg No

Maximum string length: 20
validation_status_flagenum<string>query

(Optional) Validation Status Flag

Available options: valid, failed-class, failed-gst, failed-duplicate, failed-supplier
status_flagenum<string>query

(Optional) Status Flag

Available options: pending, posted, deleted, history-only
pageintegerquerydefault:1

Optional page number

Required range: 1 <= x <= 2147483647
page_sizeintegerquerydefault:25

Optional page size

Required range: -1 <= x <= 2147483647

Response

application/vnd.catch-e-api.v1+json

Success

_embeddedobject
_linksobject
pageinteger
Example: 1
page_countinteger
Example: 1
page_sizeinteger
Example: 25
total_itemsinteger
Example: 1

Still need help? Ask the team