Számla kiállítása, fizetettre állítás, sztornózás

Számla kiállítása

Ezzel a funkcióval kiállítható egy dokumentum a rendszerbe. Hasonló adatstruktúrát vár, mint a lekérdezés. A funkciót POST kéréssel lehet elérni. Az adatokat JSON encode-olt formában várja a rendszer. Azonosítás szükséges, példa url:

$ curl -XPOST https://SystemId:APIKey@r3.minicrm.hu/Api/Invoice/ -d '{
    "Type": "Invoice",
    "CustomerId": 98,
    "Customer": {
        "Name": "Teszt User",
        "Country": "Magyarország",
        "PostalCode": "1234",
        "City": "Budapest",
        "Address": "Teszt utca 1.",
        "AccountNumber": "12345678-12345678-12345678",
        "VatNumber": "12345678-12-1"
    },
    "PaymentMethod": "Cash",
    "Issued": "2013-11-27",
    "Performance": "2013-11-27",
    "Prompt": "2013-11-30",
    "CurrencyCode": "HUF",
    "IsReverseCharge": "0",
    "Items": [
        {
            "Name": "Példa termék",
            "PriceNet": "1 000,00",
            "VAT": "27%",
            "Quantity": "2",
            "Unit": "darab"
        }
    ]
}'

CustomerId vagy ReferenceId megadása kötelező!

ContactId: Rendszerben található kontakt azonosítószáma.

ReferenceId: SyncFeed által létrehozott adatlap külső azonosító száma.

A számlához a számlázási cím kerül felhasználásra. Ha ilyen cím nem létezik, akkor a kontakt címei közül az alapértelmezett.

A Customer tömb opcionális a használatnál. Itt meg lehet adni a vevő adatait. Ha a cím már létezik a kontaktnál, akkor azt használjuk, ha nem, akkor új (alapértelmezett) számlázási címként rögzül. FONTOS! Az adószám és bankszámlaszám mezőket ilyen esetben felülírja az API!

Példa válasz sikeres mentés esetén:

{
    "Id": "13",
    "Number": "2013-E/00015",
    "Type": "Invoice",
    "Media": "PKI",
    "Customer": {
        "Name": "Teszt User",
        "CountryId": "36",
        "PostalCode": "1234",
        "City": "Budapest",
        "Address": "Teszt utca 1.",
        "AccountNumber": "12345678-12345678-12345678",
        "VatNumber": "12345678-12-1"
    },
    "Vendor": {
        "Name": "Invoice Zrt.",
        "CountryId": "36",
        "PostalCode": "1234",
        "City": "Budapest",
        "Address": "Petőfi u. 8.",
        "AccountNumber": "87654321-87654321-87654321",
        "VatNumber": "87654321-02-3",
        "RegistrationNumber": "",
        "Miscellaneous": ""
    },
    "Subject": "",
    "PaymentMethod": "Cash",
    "Issued": "2013-11-27",
    "Performance": "2013-11-27",
    "Prompt": "2013-11-30",
    "Paid": "0000-00-00",
    "CurrencyCode": "HUF",
    "AmountNet": "2000.00",
    "AmountVat": "540.00",
    "Amount": "2540.00",
    "IsReverseCharge": "0",
    "DocumentId": "66",
    "DocumentUrl": "https://d1hj6taljsfeus.cloudfront.net/doc/2013/11-27/7/m/7mgnkSkFG3YwHGcus2YEcg-50",
    "DocumentFileName": "szamla-50-2013-e-00015-1.pdf",
    "Items": [
        {
            "Name": "Példa termék",
            "Description": "",
            "PriceNet": "1 000,00",
            "VAT": "27%",
            "Quantity": "2",
            "Unit": "darab",
            "PriceNetTotal": "2 000,00",
            "PriceTotal": "2 540,00"
        }
    ]
}

Számla fizetettre állítás

Az adott számla állapotát állítja fizetettre. Díjbekérő esetén a fizetett díjbekérőből egy fizetett számlát generál. A funkciót POST kéréssel lehet elérni. Azonosítás szükséges, példa url:

$ curl -XPOST https://SystemId:APIKey@r3.minicrm.hu/Api/Invoice/16/Paid -d '{
    "Customer": {
        "Name": "Teszt User",
        "CountryId": "36",
        "PostalCode": "1234",
        "City": "Budapest",
        "Address": "Teszt utca 1.",
        "AccountNumber": "12345678-12345678-12345678",
        "VatNumber": "12345678-12-1"
    },
}'

A Customer tömb itt is használható. Ennek abban az esetben van jelentősége, ha a díjbekérő kiállítása óta változott valamelyik adat és a számlát már az új adatokkal szeretnénk kiállítani.

A válasz díjbekérő fizetettre állítása esetén, az újonnan létrehozott számla adatait tartalmazza, minden egyéb esetben a fizetettre állított dokumentum adatait.

Példa válasz sikeres mentés esetén:

{
    "Id": "17",
    "Number": "2013-E/00016",
    "Type": "Invoice",
    "Media": "PKI",
    "Customer": {
        "Name": "Teszt User",
        "CountryId": "36",
        "PostalCode": "1234",
        "City": "Budapest",
        "Address": "Teszt utca 1.",
        "AccountNumber": "12345678-12345678-12345678",
        "VatNumber": "12345678-12-1"
    },
    "Vendor": {
        "Name": "Invoice Zrt.",
        "CountryId": "36",
        "PostalCode": "1234",
        "City": "Budapest",
        "Address": "Petőfi u. 8.",
        "AccountNumber": "87654321-87654321-87654321",
        "VatNumber": "87654321-02-3",
        "RegistrationNumber": "",
        "Miscellaneous": ""
    },
    "Subject": "DK2013-E/00002 számú díjbekérő alapján készült.",
    "PaymentMethod": "Cash",
    "Issued": "2013-11-27",
    "Performance": "2013-11-27",
    "Prompt": "2013-11-27",
    "Paid": "2013-11-27",
    "CurrencyCode": "HUF",
    "AmountNet": "12000.00",
    "AmountVat": "3240.00",
    "Amount": "15240.00",
    "IsReverseCharge": "0",
    "DocumentId": "68",
    "DocumentUrl": "https://d1hj6taljsfeus.cloudfront.net/doc/2013/11-27/g/o/go9SWT-_mUVFKQD2-m5-5w-50",
    "DocumentFileName": "szamla-50-2013-e-00016-1.pdf",
    "Items": [
        {
            "Name": "Teszt cikk 1",
            "Description": "",
            "PriceNet": "12 000,00",
            "VAT": "27%",
            "Quantity": "1",
            "Unit": "darab",
            "PriceNetTotal": "12 000,00",
            "PriceTotal": "15 240,00"
        }
    ]
}

Számla sztornózás

Egy adott számla sztornózása. A funkciót POST kéréssel lehet elérni. Azonosítás szükséges, példa url:

$ curl -XPOST https://SystemId:APIKey@r3.minicrm.hu/Api/Invoice/17/Storno

Számla esetén a rendszer automatikusan generál egy sztornó számlát. A válaszban ilyenkor a sztornó számla adatai szerepelnek, minden egyéb esetben a sztornózott számla adatai.

Példa válasz sikeres mentés esetén:

{
    "Id": "17",
    "Number": "2013-E/00016",
    "Type": "Invoice",
    "Media": "PKI",
    "Customer": {
        "Name": "Teszt User",
        "CountryId": "36",
        "PostalCode": "1234",
        "City": "Budapest",
        "Address": "Teszt utca 1.",
        "AccountNumber": "12345678-12345678-12345678",
        "VatNumber": "12345678-12-1"
    },
    "Vendor": {
        "Name": "Invoice Zrt.",
        "CountryId": "36",
        "PostalCode": "1234",
        "City": "Budapest",
        "Address": "Petőfi u. 8.",
        "AccountNumber": "87654321-87654321-87654321",
        "VatNumber": "87654321-02-3",
        "RegistrationNumber": "",
        "Miscellaneous": ""
    },
    "Subject": "DK2013-E/00002 számú díjbekérő alapján készült.",
    "PaymentMethod": "Cash",
    "Issued": "2013-11-27",
    "Performance": "2013-11-27",
    "Prompt": "2013-11-27",
    "Paid": "2013-11-27",
    "CurrencyCode": "HUF",
    "AmountNet": "12000.00",
    "AmountVat": "3240.00",
    "Amount": "15240.00",
    "IsReverseCharge": "0",
    "DocumentId": "68",
    "DocumentUrl": "https://d1hj6taljsfeus.cloudfront.net/doc/2013/11-27/g/o/go9SWT-_mUVFKQD2-m5-5w-50",
    "DocumentFileName": "szamla-50-2013-e-00016-1.pdf",
    "Items": [
        {
            "Name": "Teszt cikk 1",
            "Description": "",
            "PriceNet": "12 000,00",
            "VAT": "27%",
            "Quantity": "1",
            "Unit": "darab",
            "PriceNetTotal": "12 000,00",
            "PriceTotal": "15 240,00"
        }
    ]
}