v1

latestOpenAPI 3.1.02026-08-04103211436.0 KB
Contacts

Update contact

Updates a contact identified by customId. Note that updating a customId that does not match any contact also returns 200 without applying any change — no 404 is raised.

patch/contacts/{companyId}/{customId}

Path parameters

customIdstring required
companyIdstring required

Request body

tradeNamestring nullable

Commercial/trade name of the contact. Defaults to legalName when omitted or blank.

legalNamestring nullable

Legal (registered) name of the contact.

taxIdstring nullable

Tax identification number (CIF/NIF/VAT) of the contact. Spaces are removed before storage.

contactType'freelance' | 'company'
type'supplier' | 'client-supplier' | 'client'
additionalInfoobject nullable

Free-form key/value metadata to attach to the contact.

accountingCodestring nullable

Accounting account code this contact is linked to.

paymentMethodstring nullable

Preferred payment method for this contact.

paymentTermsinteger nullable

Payment terms granted to the contact, in days.

Example request

{
  "tradeName": "Acme Supplies",
  "legalName": "Acme Supplies S.L.",
  "taxId": "B12345678",
  "contact": {
    "phone": "+34600000000",
    "email": "billing@acme-supplies.com",
    "name": "John",
    "surname": "Doe"
  },
  "address": {
    "postalCode": "28001",
    "address": "Calle Mayor 10, 3B",
    "province": "Madrid",
    "city": "Madrid",
    "country": "Spain"
  },
  "accounts": [
    {
      "swift": "BBVAESMMXXX",
      "iban": "ES9121000418450200051332"
    }
  ],
  "paymentsAccounts": [
    {
      "details": {
        "iban": "ES9121000418450200051332",
        "bic": "BBVAESMMXXX",
        "swift": "BBVAESMMXXX",
        "accountNumber": "123456789",
        "routingNumber": "021000021",
        "sortCode": "040004",
        "institutionNumber": "001",
        "transitNumber": "12345",
        "bsb": "062-000"
      }
    }
  ],
  "accountingCode": "4300001",
  "paymentMethod": "bank-transaction",
  "paymentTerms": 30,
  "attributes": [
    {
      "customId": "cost-center",
      "value": "Marketing",
      "valueCustomId": "marketing"
    }
  ]
}

Response

Successful Response

idstring required

Embat resource ID

customIdstring required

Client-provided custom ID