Patch supplier

cURL

curl --request PATCH \
  --url https://api.maesn.dev/accounting/suppliers/{contactId} \
  --header 'Content-Type: application/json' \
  --header 'X-ACCOUNT-KEY: <x-account-key>' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '
{
  "addresses": [
    {
      "addressLine1": "Lucky street 1",
      "addressLine2": "2nd floor",
      "city": "Berlin",
      "countryCode": "DE",
      "postalCode": "10243",
      "type": "BILLING"
    }
  ],
  "companyName": "maesn",
  "contactType": "CONTACT_PERSON",
  "contactPersons": [
    {
      "emailAddresses": [
        {
          "email": "john.doe@company.com",
          "type": "BUSINESS"
        }
      ],
      "firstName": "John",
      "lastName": "Doe",
      "phoneNumbers": [
        {
          "number": "+49 7163307056",
          "type": "MOBILE"
        }
      ],
      "salutation": "Mr"
    }
  ],
  "documentId": "Z1248601M",
  "emailAddresses": [
    {
      "email": "john.doe@company.com",
      "type": "BUSINESS"
    }
  ],
  "number": "1042",
  "phoneNumbers": [
    {
      "number": "+49 7163307056",
      "type": "MOBILE"
    }
  ],
  "projectId": "3",
  "vatId": "DE123456789"
}
'

import requests

url = "https://api.maesn.dev/accounting/suppliers/{contactId}"

payload = {
    "addresses": [
        {
            "addressLine1": "Lucky street 1",
            "addressLine2": "2nd floor",
            "city": "Berlin",
            "countryCode": "DE",
            "postalCode": "10243",
            "type": "BILLING"
        }
    ],
    "companyName": "maesn",
    "contactType": "CONTACT_PERSON",
    "contactPersons": [
        {
            "emailAddresses": [
                {
                    "email": "john.doe@company.com",
                    "type": "BUSINESS"
                }
            ],
            "firstName": "John",
            "lastName": "Doe",
            "phoneNumbers": [
                {
                    "number": "+49 7163307056",
                    "type": "MOBILE"
                }
            ],
            "salutation": "Mr"
        }
    ],
    "documentId": "Z1248601M",
    "emailAddresses": [
        {
            "email": "john.doe@company.com",
            "type": "BUSINESS"
        }
    ],
    "number": "1042",
    "phoneNumbers": [
        {
            "number": "+49 7163307056",
            "type": "MOBILE"
        }
    ],
    "projectId": "3",
    "vatId": "DE123456789"
}
headers = {
    "X-API-KEY": "<x-api-key>",
    "X-ACCOUNT-KEY": "<x-account-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'X-API-KEY': '<x-api-key>',
    'X-ACCOUNT-KEY': '<x-account-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    addresses: [
      {
        addressLine1: 'Lucky street 1',
        addressLine2: '2nd floor',
        city: 'Berlin',
        countryCode: 'DE',
        postalCode: '10243',
        type: 'BILLING'
      }
    ],
    companyName: 'maesn',
    contactType: 'CONTACT_PERSON',
    contactPersons: [
      {
        emailAddresses: [{email: 'john.doe@company.com', type: 'BUSINESS'}],
        firstName: 'John',
        lastName: 'Doe',
        phoneNumbers: [{number: '+49 7163307056', type: 'MOBILE'}],
        salutation: 'Mr'
      }
    ],
    documentId: 'Z1248601M',
    emailAddresses: [{email: 'john.doe@company.com', type: 'BUSINESS'}],
    number: '1042',
    phoneNumbers: [{number: '+49 7163307056', type: 'MOBILE'}],
    projectId: '3',
    vatId: 'DE123456789'
  })
};

fetch('https://api.maesn.dev/accounting/suppliers/{contactId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.maesn.dev/accounting/suppliers/{contactId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'addresses' => [
        [
                'addressLine1' => 'Lucky street 1',
                'addressLine2' => '2nd floor',
                'city' => 'Berlin',
                'countryCode' => 'DE',
                'postalCode' => '10243',
                'type' => 'BILLING'
        ]
    ],
    'companyName' => 'maesn',
    'contactType' => 'CONTACT_PERSON',
    'contactPersons' => [
        [
                'emailAddresses' => [
                                [
                                                                'email' => 'john.doe@company.com',
                                                                'type' => 'BUSINESS'
                                ]
                ],
                'firstName' => 'John',
                'lastName' => 'Doe',
                'phoneNumbers' => [
                                [
                                                                'number' => '+49 7163307056',
                                                                'type' => 'MOBILE'
                                ]
                ],
                'salutation' => 'Mr'
        ]
    ],
    'documentId' => 'Z1248601M',
    'emailAddresses' => [
        [
                'email' => 'john.doe@company.com',
                'type' => 'BUSINESS'
        ]
    ],
    'number' => '1042',
    'phoneNumbers' => [
        [
                'number' => '+49 7163307056',
                'type' => 'MOBILE'
        ]
    ],
    'projectId' => '3',
    'vatId' => 'DE123456789'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-ACCOUNT-KEY: <x-account-key>",
    "X-API-KEY: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.maesn.dev/accounting/suppliers/{contactId}"

	payload := strings.NewReader("{\n  \"addresses\": [\n    {\n      \"addressLine1\": \"Lucky street 1\",\n      \"addressLine2\": \"2nd floor\",\n      \"city\": \"Berlin\",\n      \"countryCode\": \"DE\",\n      \"postalCode\": \"10243\",\n      \"type\": \"BILLING\"\n    }\n  ],\n  \"companyName\": \"maesn\",\n  \"contactType\": \"CONTACT_PERSON\",\n  \"contactPersons\": [\n    {\n      \"emailAddresses\": [\n        {\n          \"email\": \"john.doe@company.com\",\n          \"type\": \"BUSINESS\"\n        }\n      ],\n      \"firstName\": \"John\",\n      \"lastName\": \"Doe\",\n      \"phoneNumbers\": [\n        {\n          \"number\": \"+49 7163307056\",\n          \"type\": \"MOBILE\"\n        }\n      ],\n      \"salutation\": \"Mr\"\n    }\n  ],\n  \"documentId\": \"Z1248601M\",\n  \"emailAddresses\": [\n    {\n      \"email\": \"john.doe@company.com\",\n      \"type\": \"BUSINESS\"\n    }\n  ],\n  \"number\": \"1042\",\n  \"phoneNumbers\": [\n    {\n      \"number\": \"+49 7163307056\",\n      \"type\": \"MOBILE\"\n    }\n  ],\n  \"projectId\": \"3\",\n  \"vatId\": \"DE123456789\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-API-KEY", "<x-api-key>")
	req.Header.Add("X-ACCOUNT-KEY", "<x-account-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.maesn.dev/accounting/suppliers/{contactId}")
  .header("X-API-KEY", "<x-api-key>")
  .header("X-ACCOUNT-KEY", "<x-account-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"addresses\": [\n    {\n      \"addressLine1\": \"Lucky street 1\",\n      \"addressLine2\": \"2nd floor\",\n      \"city\": \"Berlin\",\n      \"countryCode\": \"DE\",\n      \"postalCode\": \"10243\",\n      \"type\": \"BILLING\"\n    }\n  ],\n  \"companyName\": \"maesn\",\n  \"contactType\": \"CONTACT_PERSON\",\n  \"contactPersons\": [\n    {\n      \"emailAddresses\": [\n        {\n          \"email\": \"john.doe@company.com\",\n          \"type\": \"BUSINESS\"\n        }\n      ],\n      \"firstName\": \"John\",\n      \"lastName\": \"Doe\",\n      \"phoneNumbers\": [\n        {\n          \"number\": \"+49 7163307056\",\n          \"type\": \"MOBILE\"\n        }\n      ],\n      \"salutation\": \"Mr\"\n    }\n  ],\n  \"documentId\": \"Z1248601M\",\n  \"emailAddresses\": [\n    {\n      \"email\": \"john.doe@company.com\",\n      \"type\": \"BUSINESS\"\n    }\n  ],\n  \"number\": \"1042\",\n  \"phoneNumbers\": [\n    {\n      \"number\": \"+49 7163307056\",\n      \"type\": \"MOBILE\"\n    }\n  ],\n  \"projectId\": \"3\",\n  \"vatId\": \"DE123456789\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.maesn.dev/accounting/suppliers/{contactId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<x-api-key>'
request["X-ACCOUNT-KEY"] = '<x-account-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"addresses\": [\n    {\n      \"addressLine1\": \"Lucky street 1\",\n      \"addressLine2\": \"2nd floor\",\n      \"city\": \"Berlin\",\n      \"countryCode\": \"DE\",\n      \"postalCode\": \"10243\",\n      \"type\": \"BILLING\"\n    }\n  ],\n  \"companyName\": \"maesn\",\n  \"contactType\": \"CONTACT_PERSON\",\n  \"contactPersons\": [\n    {\n      \"emailAddresses\": [\n        {\n          \"email\": \"john.doe@company.com\",\n          \"type\": \"BUSINESS\"\n        }\n      ],\n      \"firstName\": \"John\",\n      \"lastName\": \"Doe\",\n      \"phoneNumbers\": [\n        {\n          \"number\": \"+49 7163307056\",\n          \"type\": \"MOBILE\"\n        }\n      ],\n      \"salutation\": \"Mr\"\n    }\n  ],\n  \"documentId\": \"Z1248601M\",\n  \"emailAddresses\": [\n    {\n      \"email\": \"john.doe@company.com\",\n      \"type\": \"BUSINESS\"\n    }\n  ],\n  \"number\": \"1042\",\n  \"phoneNumbers\": [\n    {\n      \"number\": \"+49 7163307056\",\n      \"type\": \"MOBILE\"\n    }\n  ],\n  \"projectId\": \"3\",\n  \"vatId\": \"DE123456789\"\n}"

response = http.request(request)
puts response.read_body

{
  "meta": {
    "warnings": [
      "Field not used by target system"
    ],
    "pagination": {
      "total": 125,
      "perPage": 50,
      "currentPage": 1,
      "totalPages": 3
    }
  },
  "data": {
    "id": "92c4f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b",
    "addresses": [
      {
        "addressLine1": "Lucky street 1",
        "addressLine2": "2nd floor",
        "city": "Berlin",
        "countryCode": "DE",
        "postalCode": "10243",
        "type": "BILLING"
      }
    ],
    "companyName": "maesn",
    "contactType": "CONTACT_PERSON",
    "contactPersons": [
      {
        "emailAddresses": [
          {
            "email": "john.doe@company.com",
            "type": "BUSINESS"
          }
        ],
        "firstName": "John",
        "lastName": "Doe",
        "phoneNumbers": [
          {
            "number": "+49 7163307056",
            "type": "MOBILE"
          }
        ],
        "salutation": "Mr"
      }
    ],
    "documentId": "Z1248601M",
    "emailAddresses": [
      {
        "email": "john.doe@company.com",
        "type": "BUSINESS"
      }
    ],
    "number": "1042",
    "phoneNumbers": [
      {
        "number": "+49 7163307056",
        "type": "MOBILE"
      }
    ],
    "projectId": "3",
    "updatedDate": "2018-01-01T13:00:00.000Z",
    "vatId": "DE123456789"
  }
}

PATCH

accounting

suppliers

{contactId}

cURL

curl --request PATCH \
  --url https://api.maesn.dev/accounting/suppliers/{contactId} \
  --header 'Content-Type: application/json' \
  --header 'X-ACCOUNT-KEY: <x-account-key>' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '
{
  "addresses": [
    {
      "addressLine1": "Lucky street 1",
      "addressLine2": "2nd floor",
      "city": "Berlin",
      "countryCode": "DE",
      "postalCode": "10243",
      "type": "BILLING"
    }
  ],
  "companyName": "maesn",
  "contactType": "CONTACT_PERSON",
  "contactPersons": [
    {
      "emailAddresses": [
        {
          "email": "john.doe@company.com",
          "type": "BUSINESS"
        }
      ],
      "firstName": "John",
      "lastName": "Doe",
      "phoneNumbers": [
        {
          "number": "+49 7163307056",
          "type": "MOBILE"
        }
      ],
      "salutation": "Mr"
    }
  ],
  "documentId": "Z1248601M",
  "emailAddresses": [
    {
      "email": "john.doe@company.com",
      "type": "BUSINESS"
    }
  ],
  "number": "1042",
  "phoneNumbers": [
    {
      "number": "+49 7163307056",
      "type": "MOBILE"
    }
  ],
  "projectId": "3",
  "vatId": "DE123456789"
}
'

import requests

url = "https://api.maesn.dev/accounting/suppliers/{contactId}"

payload = {
    "addresses": [
        {
            "addressLine1": "Lucky street 1",
            "addressLine2": "2nd floor",
            "city": "Berlin",
            "countryCode": "DE",
            "postalCode": "10243",
            "type": "BILLING"
        }
    ],
    "companyName": "maesn",
    "contactType": "CONTACT_PERSON",
    "contactPersons": [
        {
            "emailAddresses": [
                {
                    "email": "john.doe@company.com",
                    "type": "BUSINESS"
                }
            ],
            "firstName": "John",
            "lastName": "Doe",
            "phoneNumbers": [
                {
                    "number": "+49 7163307056",
                    "type": "MOBILE"
                }
            ],
            "salutation": "Mr"
        }
    ],
    "documentId": "Z1248601M",
    "emailAddresses": [
        {
            "email": "john.doe@company.com",
            "type": "BUSINESS"
        }
    ],
    "number": "1042",
    "phoneNumbers": [
        {
            "number": "+49 7163307056",
            "type": "MOBILE"
        }
    ],
    "projectId": "3",
    "vatId": "DE123456789"
}
headers = {
    "X-API-KEY": "<x-api-key>",
    "X-ACCOUNT-KEY": "<x-account-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'X-API-KEY': '<x-api-key>',
    'X-ACCOUNT-KEY': '<x-account-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    addresses: [
      {
        addressLine1: 'Lucky street 1',
        addressLine2: '2nd floor',
        city: 'Berlin',
        countryCode: 'DE',
        postalCode: '10243',
        type: 'BILLING'
      }
    ],
    companyName: 'maesn',
    contactType: 'CONTACT_PERSON',
    contactPersons: [
      {
        emailAddresses: [{email: 'john.doe@company.com', type: 'BUSINESS'}],
        firstName: 'John',
        lastName: 'Doe',
        phoneNumbers: [{number: '+49 7163307056', type: 'MOBILE'}],
        salutation: 'Mr'
      }
    ],
    documentId: 'Z1248601M',
    emailAddresses: [{email: 'john.doe@company.com', type: 'BUSINESS'}],
    number: '1042',
    phoneNumbers: [{number: '+49 7163307056', type: 'MOBILE'}],
    projectId: '3',
    vatId: 'DE123456789'
  })
};

fetch('https://api.maesn.dev/accounting/suppliers/{contactId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.maesn.dev/accounting/suppliers/{contactId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'addresses' => [
        [
                'addressLine1' => 'Lucky street 1',
                'addressLine2' => '2nd floor',
                'city' => 'Berlin',
                'countryCode' => 'DE',
                'postalCode' => '10243',
                'type' => 'BILLING'
        ]
    ],
    'companyName' => 'maesn',
    'contactType' => 'CONTACT_PERSON',
    'contactPersons' => [
        [
                'emailAddresses' => [
                                [
                                                                'email' => 'john.doe@company.com',
                                                                'type' => 'BUSINESS'
                                ]
                ],
                'firstName' => 'John',
                'lastName' => 'Doe',
                'phoneNumbers' => [
                                [
                                                                'number' => '+49 7163307056',
                                                                'type' => 'MOBILE'
                                ]
                ],
                'salutation' => 'Mr'
        ]
    ],
    'documentId' => 'Z1248601M',
    'emailAddresses' => [
        [
                'email' => 'john.doe@company.com',
                'type' => 'BUSINESS'
        ]
    ],
    'number' => '1042',
    'phoneNumbers' => [
        [
                'number' => '+49 7163307056',
                'type' => 'MOBILE'
        ]
    ],
    'projectId' => '3',
    'vatId' => 'DE123456789'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-ACCOUNT-KEY: <x-account-key>",
    "X-API-KEY: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.maesn.dev/accounting/suppliers/{contactId}"

	payload := strings.NewReader("{\n  \"addresses\": [\n    {\n      \"addressLine1\": \"Lucky street 1\",\n      \"addressLine2\": \"2nd floor\",\n      \"city\": \"Berlin\",\n      \"countryCode\": \"DE\",\n      \"postalCode\": \"10243\",\n      \"type\": \"BILLING\"\n    }\n  ],\n  \"companyName\": \"maesn\",\n  \"contactType\": \"CONTACT_PERSON\",\n  \"contactPersons\": [\n    {\n      \"emailAddresses\": [\n        {\n          \"email\": \"john.doe@company.com\",\n          \"type\": \"BUSINESS\"\n        }\n      ],\n      \"firstName\": \"John\",\n      \"lastName\": \"Doe\",\n      \"phoneNumbers\": [\n        {\n          \"number\": \"+49 7163307056\",\n          \"type\": \"MOBILE\"\n        }\n      ],\n      \"salutation\": \"Mr\"\n    }\n  ],\n  \"documentId\": \"Z1248601M\",\n  \"emailAddresses\": [\n    {\n      \"email\": \"john.doe@company.com\",\n      \"type\": \"BUSINESS\"\n    }\n  ],\n  \"number\": \"1042\",\n  \"phoneNumbers\": [\n    {\n      \"number\": \"+49 7163307056\",\n      \"type\": \"MOBILE\"\n    }\n  ],\n  \"projectId\": \"3\",\n  \"vatId\": \"DE123456789\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-API-KEY", "<x-api-key>")
	req.Header.Add("X-ACCOUNT-KEY", "<x-account-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.maesn.dev/accounting/suppliers/{contactId}")
  .header("X-API-KEY", "<x-api-key>")
  .header("X-ACCOUNT-KEY", "<x-account-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"addresses\": [\n    {\n      \"addressLine1\": \"Lucky street 1\",\n      \"addressLine2\": \"2nd floor\",\n      \"city\": \"Berlin\",\n      \"countryCode\": \"DE\",\n      \"postalCode\": \"10243\",\n      \"type\": \"BILLING\"\n    }\n  ],\n  \"companyName\": \"maesn\",\n  \"contactType\": \"CONTACT_PERSON\",\n  \"contactPersons\": [\n    {\n      \"emailAddresses\": [\n        {\n          \"email\": \"john.doe@company.com\",\n          \"type\": \"BUSINESS\"\n        }\n      ],\n      \"firstName\": \"John\",\n      \"lastName\": \"Doe\",\n      \"phoneNumbers\": [\n        {\n          \"number\": \"+49 7163307056\",\n          \"type\": \"MOBILE\"\n        }\n      ],\n      \"salutation\": \"Mr\"\n    }\n  ],\n  \"documentId\": \"Z1248601M\",\n  \"emailAddresses\": [\n    {\n      \"email\": \"john.doe@company.com\",\n      \"type\": \"BUSINESS\"\n    }\n  ],\n  \"number\": \"1042\",\n  \"phoneNumbers\": [\n    {\n      \"number\": \"+49 7163307056\",\n      \"type\": \"MOBILE\"\n    }\n  ],\n  \"projectId\": \"3\",\n  \"vatId\": \"DE123456789\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.maesn.dev/accounting/suppliers/{contactId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<x-api-key>'
request["X-ACCOUNT-KEY"] = '<x-account-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"addresses\": [\n    {\n      \"addressLine1\": \"Lucky street 1\",\n      \"addressLine2\": \"2nd floor\",\n      \"city\": \"Berlin\",\n      \"countryCode\": \"DE\",\n      \"postalCode\": \"10243\",\n      \"type\": \"BILLING\"\n    }\n  ],\n  \"companyName\": \"maesn\",\n  \"contactType\": \"CONTACT_PERSON\",\n  \"contactPersons\": [\n    {\n      \"emailAddresses\": [\n        {\n          \"email\": \"john.doe@company.com\",\n          \"type\": \"BUSINESS\"\n        }\n      ],\n      \"firstName\": \"John\",\n      \"lastName\": \"Doe\",\n      \"phoneNumbers\": [\n        {\n          \"number\": \"+49 7163307056\",\n          \"type\": \"MOBILE\"\n        }\n      ],\n      \"salutation\": \"Mr\"\n    }\n  ],\n  \"documentId\": \"Z1248601M\",\n  \"emailAddresses\": [\n    {\n      \"email\": \"john.doe@company.com\",\n      \"type\": \"BUSINESS\"\n    }\n  ],\n  \"number\": \"1042\",\n  \"phoneNumbers\": [\n    {\n      \"number\": \"+49 7163307056\",\n      \"type\": \"MOBILE\"\n    }\n  ],\n  \"projectId\": \"3\",\n  \"vatId\": \"DE123456789\"\n}"

response = http.request(request)
puts response.read_body

{
  "meta": {
    "warnings": [
      "Field not used by target system"
    ],
    "pagination": {
      "total": 125,
      "perPage": 50,
      "currentPage": 1,
      "totalPages": 3
    }
  },
  "data": {
    "id": "92c4f3a2-5b8e-4d1b-8a0c-9f6e7d2f3e4b",
    "addresses": [
      {
        "addressLine1": "Lucky street 1",
        "addressLine2": "2nd floor",
        "city": "Berlin",
        "countryCode": "DE",
        "postalCode": "10243",
        "type": "BILLING"
      }
    ],
    "companyName": "maesn",
    "contactType": "CONTACT_PERSON",
    "contactPersons": [
      {
        "emailAddresses": [
          {
            "email": "john.doe@company.com",
            "type": "BUSINESS"
          }
        ],
        "firstName": "John",
        "lastName": "Doe",
        "phoneNumbers": [
          {
            "number": "+49 7163307056",
            "type": "MOBILE"
          }
        ],
        "salutation": "Mr"
      }
    ],
    "documentId": "Z1248601M",
    "emailAddresses": [
      {
        "email": "john.doe@company.com",
        "type": "BUSINESS"
      }
    ],
    "number": "1042",
    "phoneNumbers": [
      {
        "number": "+49 7163307056",
        "type": "MOBILE"
      }
    ],
    "projectId": "3",
    "updatedDate": "2018-01-01T13:00:00.000Z",
    "vatId": "DE123456789"
  }
}

Field support per integration

Business Central

If you’re not using the Interactive Authentication Flow, make sure the query parameters environmentName and companyId are correctly populated. You can obtain these values by using the GET Environments and GET Companies endpoints available under the Authentication section.

Supported request parameters:

enum

required

Available options: CONTACT_PERSON, COMPANY

string

ContactPerson[]

Show properties

string

string[]

Address[]

Show properties

string

enum

Available options (ISO 3166-1 alpha-2):AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW

enum

Available options: BILLING

EmailAddress[]

Show properties

string

enum

Available options: BUSINESS

PhoneNumber[]

Show properties

string

enum

Available options: BUSINESS

Headers

X-API-KEY

string

required

API key

X-ACCOUNT-KEY

string

required

Account key

Path Parameters

contactId

string

required

Query Parameters

companyId

string

environmentName

string

Body

application/json

addresses

object[]

Show child attributes

bankAccount

object

Show child attributes

companyName

string

Example:

"maesn"

contactType

enum<string>

Available options:

CONTACT_PERSON,

COMPANY,

UNDEFINED

Example:

"CONTACT_PERSON"

contactPersons

object[]

Show child attributes

documentId

string

Example:

"Z1248601M"

emailAddresses

object[]

Show child attributes

number

string

Example:

"1042"

phoneNumbers

object[]

Show child attributes

projectId

string

Example:

"3"

vatId

string

Example:

"DE123456789"

Response

200 - application/json

Get started

Guides

Integrations

Use cases

API reference

Knowledgebase

Patch supplier

Field support per integration

Headers

Path Parameters

Query Parameters

Body

Response

​Field support per integration

Headers

Path Parameters

Query Parameters

Body

Response

Field support per integration