Criar contato associado a um terceiro

Por meio desta API, é possível criar um contato associado a um terceiro existente. O contato ficará vinculado ao terceiro especificado e, opcionalmente, a uma filial do mesmo.

Notas importantes

  • Unicidade do nome: O nome do contato deve ser único dentro do terceiro especificado. Não é possível criar dois contatos com o mesmo nome para o mesmo terceiro.
  • Unicidade do email: Se um email for fornecido, este deve ser único em toda a empresa. Não é possível criar dois contatos com o mesmo email, mesmo que pertençam a terceiros diferentes.
  • Validação de terceiro: O third_party_code deve corresponder a um terceiro existente e ativo no sistema. A busca é case-insensitive.
  • Validação de filial: Se branch_code for fornecido, deve corresponder a uma filial válida que pertença ao terceiro especificado. A filial deve estar configurada como filho (id_parent) do terceiro principal.
  • Campos opcionais: Os campos email, telephone, movil, skype, linkedin e branch_code são opcionais. Se não forem fornecidos ou estiverem vazios, o contato será criado sem essa informação.
  • Case-insensitive: As validações de third_party_code, branch_code, email e name são case-insensitive.

Parâmetros de entrada

Deve-se enviar o seguinte body:

ParâmetroTipoRequeridoDescrição
third_party_codeTextoSimCódigo do terceiro ao qual o contato será associado. Deve existir no sistema.
nameTextoSimNome completo do contato. Deve ser único para o terceiro especificado.
roleTextoSimCargo ou função do contato dentro da organização do terceiro.
emailTextoNãoEndereço de e-mail do contato. Se fornecido, deve ser único em toda a empresa.
telephoneTextoNãoNúmero de telefone fixo do contato.
movilTextoNãoNúmero de telefone móvel do contato.
skypeTextoNãoUsuário de Skype do contato.
linkedinTextoNãoPerfil de LinkedIn do contato.
branch_codeTextoNãoCódigo da filial do terceiro à qual o contato pertence. Se fornecido, deve corresponder a uma filial válida do terceiro.

Nota: Os campos email, telephone, movil, skype, linkedin e branch_code são opcionais e podem ser enviados como cadeias vazias ou não serem incluídos no body.

Parâmetros de saída

ParâmetroTipoDescrição
idInteiroID único do contato criado.
third_party_codeTextoCódigo do terceiro associado.
third_party_nameTextoNome do terceiro associado.
nameTextoNome do contato.
emailTextoE-mail do contato.
telephoneTextoNúmero de telefone fixo do contato.
movilTextoNúmero de telefone móvel do contato.
skypeTextoUsuário de Skype do contato.
linkedinTextoPerfil de LinkedIn do contato.
roleTextoCargo ou função do contato.
branch_codeTextoCódigo da filial associada (se aplicável).
branch_nameTextoNome da filial associada (se aplicável).

Exemplo

Petição (POST): https://app.fracttal.com/api/third_parties_contacts/

{
    "third_party_code": "THIRD002",
    "name": "mateo pereze",
    "email": "[email protected]",
    "telephone": "+57 1 234 5678",
    "movil": "+57 300 123 4567",
    "skype": "mateo.pereze",
    "linkedin": "linkedin.com/in/mateo-pereze",
    "role": "Gerente de Compras",
    "branch_code": "sucursal01"
}

{
    "success": true,
    "message": "200",
    "total": 1,
    "data": {
        "id": 12345,
        "third_party_code": "THIRD002",
        "third_party_name": "Proveedor ABC S.A.S",
        "name": "mateo pereze",
        "email": "[email protected]",
        "telephone": "+57 1 234 5678",
        "movil": "+57 300 123 4567",
        "skype": "mateo.pereze",
        "linkedin": "linkedin.com/in/mateo-pereze",
        "role": "Gerente de Compras",
        "branch_code": "sucursal01",
        "branch_name": "Sucursal Norte"
    }
}

Response
200
Language
LoadingLoading…