MKG API Offerte

Getest op API V3 en MKG Versie 005.090.002.

---

Inhoudsopgave Opvragen Lijst met verkopers Aanmaken Verkoopofferteheader Verkoopofferteregel Termijnplan Offerteregel in calculatie nemen Calculatiehalffabricaten toevoegen Calculatiematerialen toevoegen Calculatiebewerkingen toevoegen

---

Data dictionary Voor informatie over endpoints, velden en acties, zie dit artikel.

 

Postman Voor voorbeelden van API-aanroepen, zie dit artikel.

 

Opvragen

 

Relatie Voor het opvragen van een debiteur en/of relatie, zie dit artikel.

 

Lijst met verkopers

Voor het opvragen van een lijst met verkopers kan de volgende aanroep worden gebruikt. De API maakt gebruik van paginering, waarbij maximaal 1000 regels in één aanroep worden aangeboden.

GET {{restUrl}}/Documents/verk

• Filter: verk_actief = true
• Fieldlist: medw_num,verk_naam,verk_num
• NumRows: 10

{{restUrl}}/Documents/verk/?Filter=verk_actief = true&Fieldlist=medw_num,verk_naam,verk_num&NumRows=10

 

Aanmaken

 

Relatie Voor het aanmaken van een debiteur en/of relatie, zie dit artikel.

 

Verkoopofferteheader

Voor het aanmaken van een verkoopofferte moet een relatie zijn aangemaakt waar deze aan wordt gekoppeld. Deze relatie wordt gekoppeld met de variabel {{rela_num}}. Het is dus wel mogelijk om een verkoopofferte aan te maken zonder dat een debiteur gekoppeld is. Wel is een debiteur nodig om de offerte door te zetten naar een verkooporder. Wanneer het debiteurnummer bekend is, hoef je het relatienummer niet mee te geven in de call.

POST {{restUrl}}/Documents/vofh

{{restUrl}}/Documents/vofh

Request body:

{
    "request": {
        "InputData": {
            "vofh": [
                {
                    "admi_num": {{admi_num}},
                    "rela_num": {{rela_num}},
                    "debi_num": {{debi_num}},
                    "vofh_ref_onze": "Our reference",
                    "vofh_ref_uw": "Customer reference",
                    "vofh_bestelcode_extern": "Customer order code"
                }
            ]
        }
    }
}

 

Verkoopofferteregel

Voor het aanmaken van een verkoopofferteregel moet een verkoopofferte zijn aangemaakt waar deze aan wordt gekoppeld. De verkoopofferte wordt gekoppeld met de variabel {{vofh_num}}.

POST {{restUrl}}/Documents/vofr

{{restUrl}}/Documents/vofr

Request body:

{
    "request": {
        "InputData": {
            "vofr": [
                {
                    "vofh_num": {{vofh_num}},
                    "vofr_oms_1": "Sales quote line",
                    "vofr_order_aantal": 100,
                    "vofr_eenh_order": "st."
                }
            ]
        }
    }
}

 

Termijnplan

Een termijnplan in MKG is een sjabloon dat wordt gebruikt voor termijnfactureringen. Je maakt het termijnplan eenmalig aan, waarna je het herhaaldelijk kunt toepassen op verschillende verkooporders. Dit maakt het gemakkelijker om betalingen in termijnen te regelen, zoals een betaling vooraf, betaling bij levering en betaling achteraf.

PUT{{restUrl}}/Documents/vofh/{{admi_num}}+{{vofh_num}}/Service/s_term_plan?DialogResult=1

{{restUrl}}/Documents/vofh/{{admi_num}}+{{vofh_num}}/Service/s_term_plan?DialogResult=1

Request body:

{
    "request": {
        "InputData": {
            "clcb": [
                {
                    "admi_num": 1,
                    "vofh_num": {{vofhnum}},
                    "t_tmph": 1,
                    "t_vofr_list": "1,2",
                    "t_tmph_datum": "2023-03-30",
                    "t_tmph_ingave": "2000.00",
                    "RowKey": 1
                }
            ]
        }
    }
}

Offerteregel in calculatie nemen

In MKG betekent de actie In calculatie nemen het aanmaken van een calculatie voor een verkoopofferte, waarbij de kosten voor materialen, bewerkingen en andere productiekosten worden berekend. Bij het in calculatie nemen wordt ook direct een eindproduct aangemaakt.

POST{{restUrl}}/Documents/vofr/{{admi_num}}+{{vofh_num}}+{{vofr_num}}/Service/s_actie_in_calculatie?FieldList=clch_num

{{restUrl}}/Documents/vofr/{{admi_num}}+{{vofh_num}}+{{vofr_num}}/Service/s_actie_in_calculatie?FieldList=clch_num

 

Calculatiehalffabricaten toevoegen

Na het in calculatie nemen, is al een eindproduct aangemaakt. Een calculatie mag niet meer dan 1 eindproduct hebben. Met de onderstaande aanroep kun je een halffabricaat onder het eindproduct toevoegen.

POST {{restUrl}}/Documents/clcr/

{{restUrl}}/Documents/clcr/

Request body:

{
    "request": {
        "InputData": {
            "clcr": [
                {
                    "admi_num": {{admi_num}},
                    "clch_num": {{clch_num}},
                    "clcr_parent": 1,
                    "arti_code": "TEST ARTIKEL",
                    "clcr_oms_1": "API eindproduct",
                    "clcr_tot_aantal": 10
                }
            ]
        }
    }
}

 

Calculatiematerialen toevoegen

POST {{restUrl}}/Documents/clcm/

{{restUrl}}/Documents/clcm/

Request body:

{
    "request": {
        "InputData": {
            "clcm": [
                {
                  "admi_num": {{admi_num}},
                  "clch_num": {{clch_num}},
                  "clcr_num": {{clcr_num}},
                  "arti_code": "TEST ARTIKEL",
                  "clcm_aantal": 10,
                  "clcm_oms_1": "API materiaal test"
                }
            ]
        }
    }
}

 

Calculatiebewerkingen toevoegen

POST {{restUrl}}/Documents/clcb/

{{restUrl}}/Documents/clcb/

Request body:

{
    "request": {
        "InputData": {
            "clcb": [
                {
                  "admi_num": {{admi_num}},
                  "clch_num": {{clch_num}},
                  "clcr_num": {{clcr_num}},
                  "bwrk_num": 1000,
                  "clcb_instel_tijd": 10,
                  "clcb_tijd_per_stuk": 10
                }
            ]
        }
    }
}