Sign in

v1

latestOpenAPI 3.1.02026-08-04103211436.0 KB
Contacts

Create contact

Creates a contact (client/supplier). If customId is omitted, Embat auto-generates one. Calling this endpoint again with a customId that already exists updates the existing contact instead of creating a duplicate or raising a conflict error; if the submitted data is identical to the stored contact, the call is a no-op.

post/contacts/{companyId}

Path parameters

companyIdstring required

Request body

tradeNamestring nullable

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

legalNamestring required

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' required
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.

customIdstring nullable

Your own unique ID for the contact. If omitted, Embat auto-generates one.

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"
    }
  ],
  "customId": "erp-contact-001"
}

Response

Successful Response

idstring required

Embat resource ID

customIdstring required

Client-provided custom ID