Contact Account field reference

  • Code: optional, if not specified it will be auto generated; (max 50 characters); details

  • Description: required; (max 200 characters)

  • IntRef: optional, must be unique; (max 50 characters); details

  • CompanyNo: optional; (max 50 characters)

  • TaxNo: optional; (max 50 characters)

  • LegacyRef: optional; (max 50 characters)

  • TheirRef: optional, reference field; (max 50 characters)

  • CountryCode: optional, ISO 3166-1 alpha-2

  • ContactClassificationId: optional, code (see Contact Classification)

  • IsParent: optional, boolean

  • ParentContactAccountId: optional, code (see Contact Account)

  • Customer: JSON; if specified, it will enable the customer record for this contact account.

    • ContactGroupCustomerId: required, will also be used to default all the other unspecified fields

    The rest of the properties are optional and if they are not specified they default from the contact group:

    • Currency: supports ISO 4217 currency codes (3 characters) and cryptocurrency codes (max 5 characters)
    • PaymentMethodId: code (see Payment Method)
    • PayTermId: code (see Pay Term)
    • ReceiveInvoices: boolean
    • ReceiveReminders: boolean
    • ReceiveStatements: boolean
    • ReminderGroupId: code (see Reminder Group)
    • TaxBandId: code (see Tax Band)
    • TaxAuthorityId: code (see Tax Authority)
    • ApplyDomesticReverseCharge: When applicable for the specified Tax Authority, Domestic Reverse Charge will be applied to documents produced for the customer
    • CostCentreId: default cost centre, code (see Cost Centre)
    • DepartmentId: default department

    Additional properties, not defaulted from the contact group:

    • CostCentreFixed: boolean, if true, the cost centre cannot be amended on transactions
    • CreditLimit: decimal
    • CreditReportDate: ISO 8601
    • CreditScore: decimal
    • DefaultDeliveryAddressId: id (see Contact Address), only available when updating a customer
    • DefaultInvoiceAddressId: id (see Contact Address), only available when updating a customer
    • DepartmentFixed: boolean, if true, the department cannot be amended on transactions
    • DiscountRate: decimal
    • Ext: custom fields, JSON object
    • IgnoreDeferredIncome: boolean
    • IgnoreDeposit: boolean
    • IgnoreSchedule: boolean
    • IsHold: boolean
    • IsStop: boolean
    • IsMultiTaxAuthority: boolean
    • MultiTaxAuthorityIds: array
    • OrderRequired: boolean
    • ProductPriceBandId: code (see Product Price Band)
    • ProjectId: default project, code (see Project)
    • RiskLevel: max 500 characters
    • StockLocationId: code (see Stock Location)
    • TaxBandFixed: boolean, if true, the tax band cannot be amended on transactions
    • WarningMessage: default warning message

  • Supplier: if specified, it will enable a supplier record for this contact account

    • ContactGroupSupplierId: required, will also be used to default all the other unspecified fields

    The rest of the properties are optional and if they are not specified they default from the contact group:

    • AllowInvoiceDuplication: boolean
    • AllowSelfBilling: boolean
    • Currency: supports ISO 4217 currency codes (3 characters) and cryptocurrency codes (max 5 characters)
    • IsResale: boolean
    • PaymentMethodId: code (see Payment Method)
    • PayTermId: code (see Pay Term)
    • SendRemittance: boolean
    • TaxBandId: code (see Tax Band)
    • TaxAuthorityId: code (see Tax Authority)
    • ApplyDomesticReverseCharge: When applicable for the specified Tax Authority, Domestic Reverse Charge will be applied to documents produced for the supplier
    • CostCentreId: default cost centre
    • DepartmentId: default department

    Additional properties, not defaulted from the contact group:

    • AccountId: default account, code (see Account)
    • BankAccountId: default bank account, code (see Bank Account)
    • CostCentreFixed: boolean, if true, the cost centre cannot be amended on transactions
    • CreditLimit: decimal
    • DefaultDeliveryAddressId: id (see Contact Address), only available when updating a supplier
    • DefaultInvoiceAddressId: id (see Contact Address), only available when updating a supplier
    • DepartmentFixed: boolean, if true, the department cannot be amended on transactions
    • DiscountRate: decimal
    • Ext: custom fields, JSON object
    • IgnorePrepayment: boolean
    • IsHold: boolean
    • IsOcrGross: boolean
    • IsMultiTaxAuthority: boolean
    • IsStop: boolean
    • LegalEntityId: default legal entity, code (see Legal Entity)
    • MultiTaxAuthorityIds: array
    • OcrAliases: comma-separated list
    • OcrCombineLineItems: boolean
    • OcrDisableLineItems: boolean
    • PaymentRecipientContactAccountId: code (see Contact Pay Recipient)
    • ProductId: default product, code (see Product)
    • ProductPriceBandId: code (see Product Price Band)
    • ProjectId: default project, code (see Project)
    • ResponsibleResourceId: default responsible resource (see Resource)
    • StockLocationId: code (see Stock Location)
    • TaxBandFixed: boolean, if true, the tax band cannot be amended on transactions
    • WarningMessage: default warning message

  • Resource: if specified, it will enable a resource record for this contact account

    • ResourceGroupId: required, will also be used to default all the other unspecified fields

    The rest of the properties are optional and if they are not specified they default from the resource group:

    • DepartmentId: code (see Department)
    • AbsenceGroupId: code (see Absence Group)
    • CostCentreId: code (see Cost Centre)
    • ManagerResourceId: code (see Contact Account)
    • IsSalesperson: boolean
    • IsBuyer: boolean
    • IsRequestor: boolean
    • AllowExpense: boolean
    • AllowTask: boolean
    • AllowTimesheet: boolean
    • HasEmployment: boolean
    • HasUmbrella: boolean
    • PaymentMethodId: code (see Payment Methods)
    • PaymentTermsId: code (see Pay Term)
    • SendRemittance: boolean

    Additional properties, not defaulted from the resource group:

    • LocationId: optional, code (see Location)
    • NationalInsuranceNo: optional, max 50 characters
    • UniqueTaxpayerReference: optional, max 50 characters
    • ResourceEmployments: optional, JSON array:
      • DateFrom: optional, ISO 8601
      • DateTo: optional, ISO 8601
      • LegalEntityId: optional, code (see Legal Entity)
      • EmploymentTypeId: optional, code (see Employment Type)
      • JobTitle: optional, max 50 characters
      • JobGrade: optional, max 50 characters
      • PaymentFrequencyId: optional, max 50 characters
      • PreviousEmployer: optional, max characters
      • TerminationNoticeDays: optional, integer
    • ResourceUmbrellas: optional, JSON array:
      • UmbrellaContactAccountId: required, code (see Contact Account)
      • DateFrom: required, ISO 8601
      • DateTo: optional, ISO 8601
    • Ext: custom fields, JSON object

  • Contact: optional, the main contact account details

    • CompanyName: required, max 200 characters

    • Addresses: optional, JSON array:

      • PostCode: optional, max 50 characters
      • Address: required, max 200 characters (may contain new line separators)
      • City: optional, max 50 characters
      • County: optional, max 50 characters
      • CountryCode: optional, ISO 3166-1 alpha-2

    • Phones: optional, JSON array:

    • Emails: optional, JSON array:

  • Contacts: optional, additional people

    • CompanyName: optional, max 200 characters
    • Title: optional, max 50 characters
    • FirstName: optional, max 150 characters
    • MiddleName: optional, max 150 characters
    • LastName: optional, max 150 characters
    • Suffix: optional, max 50 characters
    • JobTitle: optional, max 50 characters
    Note

    At least one of the CompanyName, FirstName, LastName is required to create a contact.

    • If only a CompanyName is specified, the contact will be a Company type record.
    • If any of the FirstName, LastName are specified, the contact will be a Person type record.
    • Addresses: optional, JSON array (same as above)
    • Phones: optional, JSON array (same as above)
    • Emails: optional, JSON array (same as above)