Patch customer

cURL

curl --request PATCH \
  --url https://api.maesn.dev/accounting/customers/{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"
}
'

{
  "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

customers

{contactId}

cURL

curl --request PATCH \
  --url https://api.maesn.dev/accounting/customers/{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"
}
'

{
  "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:

contactType

enum

required

Available options: CONTACT_PERSON, COMPANY

companyName

string

contactPersons

ContactPerson[]

Show properties

firstName

string

lastName

string

emailAddresses

string[]

phoneNumbers

string[]

addresses

Address[]

Show properties

addressLine1

string

addressLine2

string

postalCode

string

city

string

countryCode

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

type

enum

Available options: BILLING

emailAddresses

EmailAddress[]

Show properties

string

type

enum

Available options: BUSINESS

phoneNumbers

PhoneNumber[]

Show properties

number

string

type

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

​Field support per integration

Headers

Path Parameters

Query Parameters

Body

Response

Field support per integration