Product Docs Help

customers

Get the customers of a merchant

GET method/customers

Returns a list of customers of a merchant

Responses

[ { "mexcParamvaluesetsid": 1000, "date": "2022-08-07T15:50:57.000Z", "customerid": "Test-Customer", "name": "Test-Name", "address": "Test-Address", "postcode": "Test-Post code", "postoffice": "Test-Post office", "state": "Test-state", "countrycode": "se", "telephone": "Test-Telephone", "fax": "Test-Fax", "mobile": "Test-Mobile", "deliveryaddress": "Test-Delivery address", "deliverypostcode": "Test-Delivery post code", "deliverypostoffice": "Test-Delivery office", "email": "test@billmate.se", "reference": "Test-Reference", "companyno": "Test-Company no", "vatregno": "Test-vatreg no", "paymentterms": "Test-Payment", "rebate": "Test-Rebate", "currency": "SEK", "language": "sv", "export": "Test-Export", "handlingcharge": "Test-Charge", "reversetax": "Test-Reverse tax", "mexcModulesid": 1000, "mm3servicesid": 1000, "country": "Sweden", "creditlimit": "Test-Credit limit", "customertypecode": "Test-Customer type code", "deliveryterms": "Test-Delivery terms", "deliverymethod": "Test-Delivery method", "deliveryname": "Test-Delivery name", "deliveryaddress2": "Test-Delivery address2", "deliverycountrycode": "Test-Delivery country code", "deliverycountry": "Test-Delivery country", "profile": "Test-Profile", "name2": "Test-Name2", "address2": "Test-Address2", "propertydesignation": "Test-Property designation", "housingassociationregno": "Test-Housing association reg no", "status": "Test-Status", "statuslog": "Test-Status log", "longitude": "Test-Longitude", "latitude": "Test-Latitude", "glncode": "Test-Gln code", "reference_order": "Test-Reference order", "email_order": "Test-Email order", "reference_offer": "Test-Reference offer", "email_offer": "Test-Email offer", "notes": "Test-Notes", "origin": "Test-Origin", "pricelist": "Test-Price list", "crediflowPartyId": "Test-Credit flow party id" } ]

Place a customer for a Merchant

POST method/customers

Place a new customer in the customers of a Merchant

Request parameters

{ "mexcParamvaluesetsid": 1000, "date": "2022-08-07T15:50:57.000Z", "customerid": "Test-Customer", "name": "Test-Name", "address": "Test-Address", "postcode": "Test-Post code", "postoffice": "Test-Post office", "state": "Test-state", "countrycode": "se", "telephone": "Test-Telephone", "fax": "Test-Fax", "mobile": "Test-Mobile", "deliveryaddress": "Test-Delivery address", "deliverypostcode": "Test-Delivery post code", "deliverypostoffice": "Test-Delivery office", "email": "test@billmate.se", "reference": "Test-Reference", "companyno": "Test-Company no", "vatregno": "Test-vatreg no", "paymentterms": "Test-Payment", "rebate": "Test-Rebate", "currency": "SEK", "language": "sv", "export": "Test-Export", "handlingcharge": "Test-Charge", "reversetax": "Test-Reverse tax", "mexcModulesid": 1000, "mm3servicesid": 1000, "country": "Sweden", "creditlimit": "Test-Credit limit", "customertypecode": "Test-Customer type code", "deliveryterms": "Test-Delivery terms", "deliverymethod": "Test-Delivery method", "deliveryname": "Test-Delivery name", "deliveryaddress2": "Test-Delivery address2", "deliverycountrycode": "Test-Delivery country code", "deliverycountry": "Test-Delivery country", "profile": "Test-Profile", "name2": "Test-Name2", "address2": "Test-Address2", "propertydesignation": "Test-Property designation", "housingassociationregno": "Test-Housing association reg no", "status": "Test-Status", "statuslog": "Test-Status log", "longitude": "Test-Longitude", "latitude": "Test-Latitude", "glncode": "Test-Gln code", "reference_order": "Test-Reference order", "email_order": "Test-Email order", "reference_offer": "Test-Reference offer", "email_offer": "Test-Email offer", "notes": "Test-Notes", "origin": "Test-Origin", "pricelist": "Test-Price list", "crediflowPartyId": "Test-Credit flow party id" }

Responses

{ "mexcParamvaluesetsid": 1000, "date": "2022-08-07T15:50:57.000Z", "customerid": "Test-Customer", "name": "Test-Name", "address": "Test-Address", "postcode": "Test-Post code", "postoffice": "Test-Post office", "state": "Test-state", "countrycode": "se", "telephone": "Test-Telephone", "fax": "Test-Fax", "mobile": "Test-Mobile", "deliveryaddress": "Test-Delivery address", "deliverypostcode": "Test-Delivery post code", "deliverypostoffice": "Test-Delivery office", "email": "test@billmate.se", "reference": "Test-Reference", "companyno": "Test-Company no", "vatregno": "Test-vatreg no", "paymentterms": "Test-Payment", "rebate": "Test-Rebate", "currency": "SEK", "language": "sv", "export": "Test-Export", "handlingcharge": "Test-Charge", "reversetax": "Test-Reverse tax", "mexcModulesid": 1000, "mm3servicesid": 1000, "country": "Sweden", "creditlimit": "Test-Credit limit", "customertypecode": "Test-Customer type code", "deliveryterms": "Test-Delivery terms", "deliverymethod": "Test-Delivery method", "deliveryname": "Test-Delivery name", "deliveryaddress2": "Test-Delivery address2", "deliverycountrycode": "Test-Delivery country code", "deliverycountry": "Test-Delivery country", "profile": "Test-Profile", "name2": "Test-Name2", "address2": "Test-Address2", "propertydesignation": "Test-Property designation", "housingassociationregno": "Test-Housing association reg no", "status": "Test-Status", "statuslog": "Test-Status log", "longitude": "Test-Longitude", "latitude": "Test-Latitude", "glncode": "Test-Gln code", "reference_order": "Test-Reference order", "email_order": "Test-Email order", "reference_offer": "Test-Reference offer", "email_offer": "Test-Email offer", "notes": "Test-Notes", "origin": "Test-Origin", "pricelist": "Test-Price list", "crediflowPartyId": "Test-Credit flow party id" }

Delete multiple customers

DELETE method/customers

Remove more than one customer

Request parameters

[ 10000, 10000 ]

Responses

{ "result": "Removed", "count": 2 }

Get the number of matching customers according to the supplied filters

GET method/customers/count

Returns object with a count representing the number of customers that matches the current filter.

Responses

{ "count": 7 }

Find customer by mexcParamvaluesetsid

GET method/customers/{mexcParamvaluesetsid}

Returns a single customer

Request parameters

Responses

{ "mexcParamvaluesetsid": 1000, "date": "2022-08-07T15:50:57.000Z", "customerid": "Test-Customer", "name": "Test-Name", "address": "Test-Address", "postcode": "Test-Post code", "postoffice": "Test-Post office", "state": "Test-state", "countrycode": "se", "telephone": "Test-Telephone", "fax": "Test-Fax", "mobile": "Test-Mobile", "deliveryaddress": "Test-Delivery address", "deliverypostcode": "Test-Delivery post code", "deliverypostoffice": "Test-Delivery office", "email": "test@billmate.se", "reference": "Test-Reference", "companyno": "Test-Company no", "vatregno": "Test-vatreg no", "paymentterms": "Test-Payment", "rebate": "Test-Rebate", "currency": "SEK", "language": "sv", "export": "Test-Export", "handlingcharge": "Test-Charge", "reversetax": "Test-Reverse tax", "mexcModulesid": 1000, "mm3servicesid": 1000, "country": "Sweden", "creditlimit": "Test-Credit limit", "customertypecode": "Test-Customer type code", "deliveryterms": "Test-Delivery terms", "deliverymethod": "Test-Delivery method", "deliveryname": "Test-Delivery name", "deliveryaddress2": "Test-Delivery address2", "deliverycountrycode": "Test-Delivery country code", "deliverycountry": "Test-Delivery country", "profile": "Test-Profile", "name2": "Test-Name2", "address2": "Test-Address2", "propertydesignation": "Test-Property designation", "housingassociationregno": "Test-Housing association reg no", "status": "Test-Status", "statuslog": "Test-Status log", "longitude": "Test-Longitude", "latitude": "Test-Latitude", "glncode": "Test-Gln code", "reference_order": "Test-Reference order", "email_order": "Test-Email order", "reference_offer": "Test-Reference offer", "email_offer": "Test-Email offer", "notes": "Test-Notes", "origin": "Test-Origin", "pricelist": "Test-Price list", "crediflowPartyId": "Test-Credit flow party id" }

Delete a customer

DELETE method/customers/{mexcParamvaluesetsid}

Removes a customer

Request parameters

Responses

{ "result": "Removed", "mexcParamvaluesetsid": 10000 }

Update an existing customer

PATCH method/customers/{mexcParamvaluesetsid}

Update an existing customer by mexcParamvaluesetsid

Request parameters

{ "mexcParamvaluesetsid": 1000, "date": "2022-08-07T15:50:57.000Z", "customerid": "Test-Customer", "name": "Test-Name", "address": "Test-Address", "postcode": "Test-Post code", "postoffice": "Test-Post office", "state": "Test-state", "countrycode": "se", "telephone": "Test-Telephone", "fax": "Test-Fax", "mobile": "Test-Mobile", "deliveryaddress": "Test-Delivery address", "deliverypostcode": "Test-Delivery post code", "deliverypostoffice": "Test-Delivery office", "email": "test@billmate.se", "reference": "Test-Reference", "companyno": "Test-Company no", "vatregno": "Test-vatreg no", "paymentterms": "Test-Payment", "rebate": "Test-Rebate", "currency": "SEK", "language": "sv", "export": "Test-Export", "handlingcharge": "Test-Charge", "reversetax": "Test-Reverse tax", "mexcModulesid": 1000, "mm3servicesid": 1000, "country": "Sweden", "creditlimit": "Test-Credit limit", "customertypecode": "Test-Customer type code", "deliveryterms": "Test-Delivery terms", "deliverymethod": "Test-Delivery method", "deliveryname": "Test-Delivery name", "deliveryaddress2": "Test-Delivery address2", "deliverycountrycode": "Test-Delivery country code", "deliverycountry": "Test-Delivery country", "profile": "Test-Profile", "name2": "Test-Name2", "address2": "Test-Address2", "propertydesignation": "Test-Property designation", "housingassociationregno": "Test-Housing association reg no", "status": "Test-Status", "statuslog": "Test-Status log", "longitude": "Test-Longitude", "latitude": "Test-Latitude", "glncode": "Test-Gln code", "reference_order": "Test-Reference order", "email_order": "Test-Email order", "reference_offer": "Test-Reference offer", "email_offer": "Test-Email offer", "notes": "Test-Notes", "origin": "Test-Origin", "pricelist": "Test-Price list", "crediflowPartyId": "Test-Credit flow party id" }

Responses

{ "mexcParamvaluesetsid": 1000, "date": "2022-08-07T15:50:57.000Z", "customerid": "Test-Customer", "name": "Test-Name", "address": "Test-Address", "postcode": "Test-Post code", "postoffice": "Test-Post office", "state": "Test-state", "countrycode": "se", "telephone": "Test-Telephone", "fax": "Test-Fax", "mobile": "Test-Mobile", "deliveryaddress": "Test-Delivery address", "deliverypostcode": "Test-Delivery post code", "deliverypostoffice": "Test-Delivery office", "email": "test@billmate.se", "reference": "Test-Reference", "companyno": "Test-Company no", "vatregno": "Test-vatreg no", "paymentterms": "Test-Payment", "rebate": "Test-Rebate", "currency": "SEK", "language": "sv", "export": "Test-Export", "handlingcharge": "Test-Charge", "reversetax": "Test-Reverse tax", "mexcModulesid": 1000, "mm3servicesid": 1000, "country": "Sweden", "creditlimit": "Test-Credit limit", "customertypecode": "Test-Customer type code", "deliveryterms": "Test-Delivery terms", "deliverymethod": "Test-Delivery method", "deliveryname": "Test-Delivery name", "deliveryaddress2": "Test-Delivery address2", "deliverycountrycode": "Test-Delivery country code", "deliverycountry": "Test-Delivery country", "profile": "Test-Profile", "name2": "Test-Name2", "address2": "Test-Address2", "propertydesignation": "Test-Property designation", "housingassociationregno": "Test-Housing association reg no", "status": "Test-Status", "statuslog": "Test-Status log", "longitude": "Test-Longitude", "latitude": "Test-Latitude", "glncode": "Test-Gln code", "reference_order": "Test-Reference order", "email_order": "Test-Email order", "reference_offer": "Test-Reference offer", "email_offer": "Test-Email offer", "notes": "Test-Notes", "origin": "Test-Origin", "pricelist": "Test-Price list", "crediflowPartyId": "Test-Credit flow party id" }

Get the person/company details by orgNum

GET method/customers/searchByOrgNumber/{orgNum}

Returns the details of the person/company

Request parameters

Responses

{ "firstname": "Kalle", "lastname": "Svensson", "company": "Test AB", "street": "Teststreet", "zip": 12341, "city": "Testcity", "country": "SE", "phone": "46701234678", "email": "billing@testcompany.com" }

Export the customers as XML

GET method/customers/export/xml

Returns a XML file that includes the customers

Responses

Export multiple customers as XML

POST method/customers/export/xml

Export the customers that are required

Request parameters

[ 10000, 10000 ]

Responses

Export the customers as CSV

GET method/customers/export/csv

Returns a CSV file that includes the customers

Responses

Export multiple customers as CSV

POST method/customers/export/csv

Export the customers that are required

Request parameters

[ 10000, 10000 ]

Responses

Last modified: 13 September 2024
currenciesdocuments