Paprika API

Paprika API – Create Client

Estimated reading: 3 minutes 116 views Contributors

Scopes Required

write:client

Linked User Privileges Required

Client Maintenance

URL

POST /api/v1/clients/createClient

Compulsory Fields

  • Account Code
  • Company
  • Short Name
  • Status

Examples

{
     "SA_ACCOUNT_CODE": "CLIENT01",
     "SA_COMPANY_NAME": "Client 1 Ltd. ",
     "SA_SHORTNAME": "Client 1",
     "SA_STATUS": "PROV",
     "SA_LEDGER_CODE": "CASH",
     "SA_DEFAULT_COST": "COST",
     "SA_DEFAULT_CHARGE": "CHRG",
     "SA_EXT_CHRG_SCALE": "EXTL",
     "SA_ES_CODE": "DEMO",
     "SA_NORM_VAT": "STD",
     "SA_BNK_CODE": "NATW"
}

Response

Success

{
     "status": true,
     "message": null,
     "result": {
          "SA_MN": 1234
     }
}

Failure

{
     "status": false,
     "message": "Account already exists",
     "result": null,
     "console": "",
     "field": "SA_ACCOUNT_CODE",
     "error": "API_ERROR",
     "value": null,
     "table": "SALES_HEAD"
}

Fields

FieldData TypeNotes
SA_ACCOUNT_CODE (required)Character(10)Must be unique
SA_COMPANY_NAME (required)Character(60)
SA_SHORTNAME (required)Character(16)
SA_STATUS (required)Character(4)Must link to a valid Client Status
SA_SGR_CODECharacter(10)Must link to a valid Client Group
SA_CONTACTCharacter(30)
SA_ADDRESSText
SA_REFCharacter(60)
SA_TELEPHONECharacter(32)
SA_FAXCharacter(32)
SA_EMAIL_ADDRESSCharacter(120)
SA_WEBCharacter(2000)
SA_SOCIAL_MEDIA1Character(400)
SA_SOCIAL_MEDIA2Character(400)
SA_SOCIAL_MEDIA3Character(400)
SA_SOCIAL_MEDIA4Character(400)
SA_SOCIAL_MEDIA5Character(400)
SA_ANAL_CODE1Character(4)Must link to a valid Analysis Code 1
SA_ANAL_CODE2Character(4)Must link to a valid Analysis Code 2
SA_ANAL_CODE3Character(4)Must link to a valid Analysis Code 3
SA_XAC_CODE1Character(4)Must link to a valid Extra Analysis Code
SA_XAC_CODE2Character(4)Must link to a valid Extra Analysis Code
SA_XAC_CODE3Character(4)Must link to a valid Extra Analysis Code
SA_XAC_CODE4Character(4)Must link to a valid Extra Analysis Code
SA_XAC_CODE5Character(4)Must link to a valid Extra Analysis Code
SA_EXTRA_1Character(60)
SA_EXTRA_2Character(60)
SA_EXTRA_3Character(60)
SA_DATE_1Date
SA_DATE_2Date
SA_DATE_3Date
SA_DATE_4Date
SA_NUMBER_1Number(2dp)
SA_NUMBER_2Number(2dp)
SA_NUMBER_3Number(2dp)
SA_NUMBER_4Number(2dp)
SA_TEXT_1Character(200)
SA_TEXT_2Character(200)
SA_TEXT_3Character(200)
SA_TEXT_4Character(200)
SA_STAFF_1Character(20)Must link to a valid Personnel
SA_STAFF_2Character(20)Must link to a valid Personnel
SA_STAFF_3Character(20)Must link to a valid Personnel
SA_STAFF_4Character(20)Must link to a valid Personnel
SA_GRP_CODECharacter(4)Must link to a valid User Group
SA_LEDGER_CODE (required)Character(4)Must link to a valid Ledger Code
SA_DEFAULT_COST (required)Character(4)Must link to a valid Cost Scale
SA_DEFAULT_CHARGE (required)Character(4)Must link to a valid Charge Scale (in the HOME currency)
SA_EXT_CHRG_SCALE (required)Character(4)Must link to a valid Charge Scale
SA_ES_CODE (required)Character(4)Must link to a valid Expense Scale
SA_NORM_VAT (required)Character(4)Must link to a valid VAT Code
SA_BNK_CODECharacter(4)Must link to a valid Bank account
SA_BILLING_CONTACTCharacter(60)
SA_ADDRESS2Character(300)
SA_BILLING_TELEPHONECharacter(32)
SA_BILLING_EMAILCharacter(240)
SA_PAY_TERMSCharacter(4)Must link to a valid Payment Term
SA_INVOICE_DAYSInteger0-255
SA_PAY_DAY_MNTHInteger0-31
SA_EXP_PAY_TERMSCharacter(4)Must link to a valid Payment Term
SA_EXP_PAY_DAYSInteger0-255
SA_PTT_CODECharacter(4)Must link to a valid Payment Terms Text
SA_PMNT_METHODCharacter(8)
SA_CREDIT_LIMITNumber(2dp)
SA_VAT_REG_NOCharacter(40)
SA_COU_CODECharacter(4)Must link to a valid Country Code
SA_BANK_ACC_NUMCharacter(32)
SA_SORT_CODECharacter(32)
SA_BANK_ACC_NAMECharacter(120)
SA_SMALL_COMPANYBoolean
Share This Page

Paprika API – Create Client

Or copy link

Contents

Proudly powered by WordPress


Pip

I can help you find guides and answer general questions instantly. I can't answer specific info about your company. I'm still learning, so if anything seems off, please double-check the Help Hub articles for the final word.

You are offline
Chatbot Avatar
Hi there, I'm Pip, your AI-powered Paprika expert. How can I help you?