Procurement APIs
Create new product matching rule
| HTTP method | POST |
| URI | https://api.rambase.net/procurement/imported-invoices/product-matching-rules |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 6852, version 6 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
Priority
Required/mandatory field
Product matching rule priority
Minimum value: 1
>{Integer}</Priority>ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
>{Integer}</ProductId>SupplierId
Required/mandatory field
RamBase supplier identifier
Minimum value: 100
>{Integer}</SupplierId>Priority
Required/mandatory field
Product matching rule priority
Minimum value: 1
": "{Integer}",ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
": "{Integer}"SupplierId
Required/mandatory field
RamBase supplier identifier
Minimum value: 100
": "{Integer}"The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
ProductMatchingRuleId
Product matching rule identifier
>{Integer}</ProductMatchingRuleId>Description
Product matching rule description
>{String}</Description>Status
Product matching rule status
Possible domain values can be found here
>{Integer}</Status>Priority
Product matching rule priority
>{Integer}</Priority>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Operator
Product matching rule operator
Possible domain values can be found here
>{String}</Operator>Condition
Product matching rule condition
>{String}</Condition>EmployeeId
Employee identifier
>{Integer}</EmployeeId>LastName
Last name of employee
>{String}</LastName>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>SupplierId
RamBase supplier identifier
>{Integer}</SupplierId>Name
Name of supplier (name of company or surname/familyname/lastname of a person)
>{String}</Name>FirstName
Firstname/givenname if the supplier is a person
>{String}</FirstName>SupplierLink
Supplier reference
>{String}</SupplierLink>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>ProductLink
Product reference
>{String}</ProductLink>ProductMatchingRuleId
Product matching rule identifier
": "{Integer}",Description
Product matching rule description
": "{String}",Status
Product matching rule status
Possible domain values can be found here
": "{Integer}",Priority
Product matching rule priority
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Field
Product matching rule field
Possible domain values can be found here
": "{String}",Operator
Product matching rule operator
Possible domain values can be found here
": "{String}",Condition
Product matching rule condition
": "{String}",EmployeeId
Employee identifier
": "{Integer}",LastName
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{String}"SupplierId
RamBase supplier identifier
": "{Integer}",Name
Name of supplier (name of company or surname/familyname/lastname of a person)
": "{String}",FirstName
Firstname/givenname if the supplier is a person
": "{String}",SupplierLink
Supplier reference
": "{String}"ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Type
Type of product
Possible domain values can be found here
": "{String}",ProductLink
Product reference
": "{String}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 100138 HTTP 400 | Only the operators NE and EQ can be used on Values containing a comma list or wildcards ( ?, * ) |
| Error 102063 HTTP 400 | Wildcard compare does not support both ? and * |
| Error 102064 HTTP 400 | Wildcard compare does not support more than two asterisks (*) |