Insert/Update billing customers

Deprecated

POST

/api

Last modified:2024-08-14 15:36:23

To insert or update a billing customer you need to execute a POST request and all the customer data need to be specified in a JSON object inside the body of the request.

The request body is the same as the one used in Insert/Update Customer, so refer to that web service for any information

Notes

There's a limit of 100 calls for this API.

Request

Query Params

Header Params

Body Params application/json

Example

{
    "subjectsRecords": [
        {
            "action": "I/U",
            "subjects": {
                "customerCode": "13245",
                "system": "DW",
                "subjectName": "Alessandro",
                "subjectName2": "Gino",
                "subjectSurname": "Covrish",
                "subjectCompanyName": "Sinesy",
                "subjectSubtype": "4",
                "extSubCompanyName": "",
                "subjectDenomination": "",
                "lawNature": "",
                "address1": "via Pordenone 1",
                "address2": "",
                "zipCode": "33170",
                "municipality": "",
                "city": "Pordenone",
                "province": "PN",
                "region": "FVG",
                "state": "",
                "country": "IT",
                "latitude": "",
                "longitude": "",
                "language": "",
                "currency": "EUR",
                "note": "",
                "sex": "M",
                "birthday": "",
                "birthPlace": "",
                "countryBirth": "IT",
                "fiscalCode": "",
                "companyVatCode": "",
                "idCard": "",
                "passport": "",
                "maritialStatus": "",
                "occupation": "",
                "title": "",
                "origin": "",
                "functionCode": "",
                "saleChannel": "",
                "organizationLevel": "",
                "territory": "",
                "purchaseInclination": "",
                "employeesNumber": 60,
                "employeesDate": "",
                "attractionLevel": "",
                "identificationLevel": "",
                "subjectBlockReason": "",
                "oldSubjectCode": "",
                "poBox": "",
                "payment": "",
                "discount": 0,
                "decisionLevel": "",
                "isCompany": "F",
                "macAddress": "",
                "ecommerceLastVisit": "2016-03-24",
                "ecommerceLastLogin": "2016-03-24",
                "ecommerceGuestRegister": "",
                "discountAuthorization": "",
                "childNumber": 2,
                "foreignPerson": "F",
                "maximumValue": 1000,
                "countryDocument": "IT",
                "vatCode": 2,
                "pec": "test@pec.it",
                "paIndex": "666D"
            },
            "contacts": [
                {
                    "contactType": "PHONE",
                    "value": "1234567890"
                },
                {
                    "contactType": "EMAIL",
                    "value": "alexander.covrish@gmail.com"
                }
            ],
            "privacy": [
                {
                    "privacyType": "",
                    "privacyConsent": "",
                    "consentDate": "",
                    "recessDate": ""
                }
            ],
            "cards": [
                {
                    "cardType": "FIDELITY",
                    "cardSubtype": "GEN",
                    "circuit": "SINESY",
                    "card": "1357924711",
                    "cardBarcode": "1357924711",
                    "issueDate": "2016-03-24",
                    "active": "",
                    "activationDate": "2016-03-24",
                    "expirationDate": "2017-03-24",
                    "cardMaster": "",
                    "cardFather": "",
                    "cardMother": "",
                    "entityCode": "",
                    "earnedPoints": 0
                }
            ],
            "subjectDestinations": [
                {
                    "destinationType": "RES",
                    "externalCode": "codice_univoco",
                    "address1": "via Tolmiech",
                    "address2": "",
                    "zipCode": "33170",
                    "municipality": "",
                    "city": "Pordenone",
                    "province": "PN",
                    "region": "",
                    "state": "",
                    "country": "IT",
                    "fax": "",
                    "mobile": "0986409232",
                    "email": "alexander.covrish@gmail.com",
                    "note": "Test note",
                    "phone": ""
                }
            ],
            "mappings": [
                {
                    "system": "DW",
                    "externalField": "CUSTOMER_ID",
                    "externalCode": 12345
                },
                {
                    "system": "DW",
                    "externalField": "CUSTOMER_NO",
                    "externalCode": 67890
                }
            ]
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api?cmd=insertBillingClient_v3&appId=KEEPIT&applicationId=KEEPIT' \
--header 'username: {{USERNAME}}' \
--header 'password: {{PASSWORD}}' \
--header 'companyId: {{COMPANY_ID}}' \
--header 'siteId: {{SITE_ID}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "subjectsRecords": [
        {
            "action": "I/U",
            "subjects": {
                "customerCode": "13245",
                "system": "DW",
                "subjectName": "Alessandro",
                "subjectName2": "Gino",
                "subjectSurname": "Covrish",
                "subjectCompanyName": "Sinesy",
                "subjectSubtype": "4",
                "extSubCompanyName": "",
                "subjectDenomination": "",
                "lawNature": "",
                "address1": "via Pordenone 1",
                "address2": "",
                "zipCode": "33170",
                "municipality": "",
                "city": "Pordenone",
                "province": "PN",
                "region": "FVG",
                "state": "",
                "country": "IT",
                "latitude": "",
                "longitude": "",
                "language": "",
                "currency": "EUR",
                "note": "",
                "sex": "M",
                "birthday": "",
                "birthPlace": "",
                "countryBirth": "IT",
                "fiscalCode": "",
                "companyVatCode": "",
                "idCard": "",
                "passport": "",
                "maritialStatus": "",
                "occupation": "",
                "title": "",
                "origin": "",
                "functionCode": "",
                "saleChannel": "",
                "organizationLevel": "",
                "territory": "",
                "purchaseInclination": "",
                "employeesNumber": 60,
                "employeesDate": "",
                "attractionLevel": "",
                "identificationLevel": "",
                "subjectBlockReason": "",
                "oldSubjectCode": "",
                "poBox": "",
                "payment": "",
                "discount": 0,
                "decisionLevel": "",
                "isCompany": "F",
                "macAddress": "",
                "ecommerceLastVisit": "2016-03-24",
                "ecommerceLastLogin": "2016-03-24",
                "ecommerceGuestRegister": "",
                "discountAuthorization": "",
                "childNumber": 2,
                "foreignPerson": "F",
                "maximumValue": 1000,
                "countryDocument": "IT",
                "vatCode": 2,
                "pec": "test@pec.it",
                "paIndex": "666D"
            },
            "contacts": [
                {
                    "contactType": "PHONE",
                    "value": "1234567890"
                },
                {
                    "contactType": "EMAIL",
                    "value": "alexander.covrish@gmail.com"
                }
            ],
            "privacy": [
                {
                    "privacyType": "",
                    "privacyConsent": "",
                    "consentDate": "",
                    "recessDate": ""
                }
            ],
            "cards": [
                {
                    "cardType": "FIDELITY",
                    "cardSubtype": "GEN",
                    "circuit": "SINESY",
                    "card": "1357924711",
                    "cardBarcode": "1357924711",
                    "issueDate": "2016-03-24",
                    "active": "",
                    "activationDate": "2016-03-24",
                    "expirationDate": "2017-03-24",
                    "cardMaster": "",
                    "cardFather": "",
                    "cardMother": "",
                    "entityCode": "",
                    "earnedPoints": 0
                }
            ],
            "subjectDestinations": [
                {
                    "destinationType": "RES",
                    "externalCode": "codice_univoco",
                    "address1": "via Tolmiech",
                    "address2": "",
                    "zipCode": "33170",
                    "municipality": "",
                    "city": "Pordenone",
                    "province": "PN",
                    "region": "",
                    "state": "",
                    "country": "IT",
                    "fax": "",
                    "mobile": "0986409232",
                    "email": "alexander.covrish@gmail.com",
                    "note": "Test note",
                    "phone": ""
                }
            ],
            "mappings": [
                {
                    "system": "DW",
                    "externalField": "CUSTOMER_ID",
                    "externalCode": 12345
                },
                {
                    "system": "DW",
                    "externalField": "CUSTOMER_NO",
                    "externalCode": 67890
                }
            ]
        }
    ]
}'

Responses

🟢200Success

application/json

Body

Example

{}

🟠422Unique constraint error

Modified at 2024-08-14 15:36:23

Insert/Update customer

Insert/Update CRM customer