Kundegrupper

Kundegrupper

Kundergrupper inneholder flere kunder, og brukes til å organisere kunder i naturlige grupper. På samme måte som enkeltkunder kan en gruppe være mottaker av en faktura, f.eks. for å sende en kontigent-faktura til flere samtidig.

Ressurs	Metode	URL
Hente alle kundegrupper	GET	/customers/groups/
Hente/oppdatere en kundegruppe	GET/POST	/customers/groups/id/
Opprette en ny kundegruppe	POST	/customers/groups/create/
Slette en kunde	POST	/customers/groups/id/delete/

Felter

Eksempelet viser en kundegruppe formattert som JSON, med feltene beskrevet under.

{
    "group": {
        "id": 7,
        "name": "Testgruppe",
        "modification_by": {
            "id": 1,
            "first_name": "Ole Nordmann", 
            "email": "[email protected]"
        },
        "creation_by": {
            "id": 1,
            "first_name": "Ole Nordmann", 
            "email": "[email protected]"
        },
        "creation_time": "2010-02-22 22:00:00",
        "modification_time": "2010-03-02 13:00:04",
        "members": [
            {
                "id": 3,
                "name": "Bentes Kafe",
                "org_number": "111111111",
                "email": "[email protected]",
                "phone_number": "12345678",
                "fax_number": "23456789",
                "contact": "Bente Nordmann",
                "web_site": "http://eksempel.no",
                "customer_number": "1000",
                "address1": "Testgata 2B",
                "address2": "",
                "zip_code": "0123",
                "zip_place": "Oslo",
                "country": 1, 
                "creation_time": "2010-04-22 22:00:00",
                "creation_by": {
                    "id": 1,
                    "first_name": "Ole Nordmann", 
                    "email": "[email protected]"
                },
                "modification_time": "2010-04-26 11:29:14",
                "modification_by": {
                    "id": 1,
                    "first_name": "Ole Nordmann", 
                    "email": "[email protected]"
                }
            },
            {
                "id": 4,
                "name": "Hansen AS",
                "org_number": "111111111",
                "email": "[email protected]",
                "phone_number": "12345678",
                "fax_number": "23456789",
                "contact": "Kari Kortholder",
                "web_site": "http://eksempel.no",
                "customer_number": "1001",
                "address1": "Testgata 3B",
                "address2": "",
                "zip_code": "0123",
                "zip_place": "Oslo",
                "country": 1, 
                "creation_time": "2010-04-22 22:00:00",
                "creation_by": {
                    "id": 1,
                    "first_name": "Ole Nordmann", 
                    "email": "[email protected]"
                },
                "modification_time": "2010-04-26 11:29:14",
                "modification_by": {
                    "id": 1,
                    "first_name": "Ole Nordmann", 
                    "email": "[email protected]"
                }
            }
        ]
    }
}

Feltnavn	Kan endres	Beskrivelse
id	Nei	Gruppens ID
name	Ja (påkrevet)	Gruppens navn
members	Ja	Liste over kunderessurser eller ID-er som skal med i gruppen.

Opprette kundegruppe

Eksempelet under viser JSON for å opprette en gruppe med to kunder med ID 4 og 5. Istedenfor ID-ene kan du også sende inn hele kunderessurser.

{
    "name": "Proxio",
    "members": [4, 5]
}