Create Sales Invoice – Billcity

Kimenő számla létrehozása.

Ez a művelet nem állítja ki a számlát, csak létrehozza piszkozatként, azaz DRAFT állapotban. Az így létrehozott piszkozat számlát az Issue Sales Invoice művelettel lehet kiállítani. Ezzel szemben a Create and Issue Sales Invoice művelet egy lépésben létrehozza, és ki állítja a számlát.

Endpoint

URL: POST /v1/sales_invoice
fejléc
- x-api-key: API-kulcs
query paraméterek
- SalesInvoiceRequestParams
body: SalesInvoice

Entitások azonosítása

A számlán szereplő alábbi entitásokra hivatkozhatunk:

number_block: id vagy name szerint,
payment_method: id vagy name szerint,
item: id vagy code szerint,
unit: id vagy name szerint,
tax_code: id vagy name szerint.

Azaz pl. a fizetési módot megadhatjuk id szerint:

{
  ...,
  "payment_method": {
    "id": 1
  },
  ...
}

Vagy név (name mező) szerint:

{
  ...,
  "payment_method": {
    "name": "Átutalás"
  },
  ...
}

Partner, supplier és customer

Minden számlát kötelezően hozzá kell rendelni egy létező partnerhez, erre szolgál a partner mező. A hozzárendelt partner a vevő, de a partneradatok nem feltétlenül egyeznek a számlán szereplő vevői adatokkal.

Létező partner több módon is azonosítható:

id alapján, ehhez a partner.id mezőt kell megadni
a magyar adószám első 8 számjegye alapján, ha az egyedi a partneradatbázisunkban, ehhez a partner.tax_number mezőt kell megadni
közösségi adószám alapján, ha az egyedi a partneradatbázisunkban, ehhez a partner.eu_vat_number mezőt kell megadni
email alapján, ha az egyedi a partneradatbázisunkban, ehhez a partner.email mezőt kell kitölteni

Ha a partner nem azonosítható, akkor a művelet létrehozza és hozzárendeli a számlához. Partner létrehozásához kötelező a name és a country mező, illetve ha akár a magyar, akár a közösségi adószám meg van adva, akkor a postal_code, city és address mezők is kötelezőek.

A supplier és a customer mezőben vannak azok a tényleges ekadói és vevői adatok, amelyek szerepelnek a számlán. Ezeknek a mezőknek nem a requestből adhatunk értéket, hanem az API tölti ki, tehát ezeket a mezőket nem is kell küldeni a requestekben.

A supplier mezőbe a Billcity beállításai szerint kerülnek a vevői adatok, amelyet a Beállítások / Általános beállítások oldalon láthatunk.

A customer mező a számlához rendelt partner adatai szerint kap értéket, de ez felülbírálható az egyes requestekből a partner többi mezője szerint.

A fentiek szerint több stratégiát követhetünk az vevői adatok meghatározására:

Ha csak a partner.id mezőt küldjük, akkor csak a BIllcity-ben felvett partnereinknek tudunk számlát kiállítani, és minden esetben a létező partneradatokból töltjük ki a vevői adatokat, viszont a Billcity-féle partner id-kat el kell tárolnunk a rendszerünk ügyféladatbázisában.
Ha csak a partner.tax_number mezőt küldjük, akkor ugyanez a helyzet, csak id helyett adószámmal azonosítjuk a partnert. Ekkor a Billcity-féle partner id-t nem kell tárolni a rendszerünkben.
Ha az id kivételével mindent kitöltünk a partner mezőben, akkor az ügyféladatbázisunk szerinti vevői adatok lesznek a számlán, illetve ha még nincs ilyen partnerünk a Billcity-ben, a művelet első alkalommal létrehozza.

Alapértelmezett értékek

Ha a számla pénzneme forint (a currency mező értéke "HUF"), akkor:

az exchange_rate mezőt nem kötelező megadni, értéke mindig 1 lesz,
az exchange_rate_source mezőt nem kötelező megadni, alapértelmezett értéke "MNB".

Egy számlasoron a unit mező elhagyható, ha a soron szereplő cikknek (item) be van állítva az alapértelmezett egysége.

Request: entitások id szerint hivatkozva

{
  "currency": "HUF",
  "number_block": {
    "id": 351
  },
  "partner": {
    "name": "Teszt Kft.",
    "tax_number": "11111111-1-11",
    "eu_vat_number": "HU11111111",
    "email": "teszt@example.com",
    "country": "HU",
    "region": "Budapest",
    "postal_code": "1234",
    "city": "Budapest",
    "address": "Teszt utca 1."
  },
  "issue_date": "2022-08-03",
  "delivery_date": "2022-07-31",
  "payment_date": "2020-08-20",
  "payment_method": {
    "id": 1222
  },
  "line_amount_type": "TAX_EXCLUSIVE",
  "lines": [
    {
      "item": {
        "id": 974
      },
      "unit": {
        "id": 1411
      },
      "tax_code": {
        "id": 2088
      },
      "quantity": "3",
      "unit_price": "1500",
      "comment": "Első cikk megjegyzése"
    },
    {
      "item": {
        "id": 975
      },
      "unit": {
        "id": 1411
      },
      "tax_code": {
        "id": 2089
      },
      "quantity": "5",
      "unit_price": "3000",
      "comment": "Második cikk megjegyzése"
    }
  ]
}

Request: entitások nem id szerint hivatkozva

{
  "currency": "HUF",
  "number_block": {
    "name": "BSZ/00000"
  },
  "partner": {
    "name": "Teszt Kft.",
    "tax_number": "11111111-1-11",
    "eu_vat_number": "HU11111111",
    "email": "teszt@example.com",
    "country": "HU",
    "region": "Budapest",
    "postal_code": "1234",
    "city": "Budapest",
    "address": "Teszt utca 1."
  },
  "issue_date": "2022-08-03",
  "delivery_date": "2022-07-31",
  "payment_date": "2020-08-20",
  "payment_method": {
    "name": "Átutalás"
  },
  "line_amount_type": "TAX_EXCLUSIVE",
  "lines": [
    {
      "item": {
        "code": "C27"
      },
      "unit": {
        "name": "db"
      },
      "tax_code": {
        "name": "Áfa 27%"
      },
      "quantity": "3",
      "unit_price": "1500",
      "comment": "Első cikk megjegyzése"
    },
    {
      "item": {
        "code": "C18"
      },
      "unit": {
        "name": "db"
      },
      "tax_code": {
        "name": "Áfa 18%"
      },
      "quantity": "5",
      "unit_price": "3000",
      "comment": "Második cikk megjegyzése"
    }
  ]
}

Request: partner id szerint azonosítva

{
  "currency": "HUF",
  "number_block": {
    "id": 351
  },
  "partner": {
    "id": 1386
  },
  "issue_date": "2022-08-03",
  "delivery_date": "2022-07-31",
  "payment_date": "2020-08-20",
  "payment_method": {
    "id": 1222
  },
  "line_amount_type": "TAX_EXCLUSIVE",
  "lines": [
    {
      "item": {
        "id": 974
      },
      "unit": {
        "id": 1411
      },
      "tax_code": {
        "id": 2088
      },
      "quantity": "3",
      "unit_price": "1500",
      "comment": "Első cikk megjegyzése"
    },
    {
      "item": {
        "id": 975
      },
      "unit": {
        "id": 1411
      },
      "tax_code": {
        "id": 2089
      },
      "quantity": "5",
      "unit_price": "3000",
      "comment": "Második cikk megjegyzése"
    }
  ]
}

Request: partner magyar adószámmal azonosítva

{
  "currency": "HUF",
  "number_block": {
    "id": 351
  },
  "partner": {
    "tax_number": "11111111-1-11"
  },
  "issue_date": "2022-08-03",
  "delivery_date": "2022-07-31",
  "payment_date": "2020-08-20",
  "payment_method": {
    "id": 1222
  },
  "line_amount_type": "TAX_EXCLUSIVE",
  "lines": [
    {
      "item": {
        "id": 974
      },
      "unit": {
        "id": 1411
      },
      "tax_code": {
        "id": 2088
      },
      "quantity": "3",
      "unit_price": "1500",
      "comment": "Első cikk megjegyzése"
    },
    {
      "item": {
        "id": 975
      },
      "unit": {
        "id": 1411
      },
      "tax_code": {
        "id": 2089
      },
      "quantity": "5",
      "unit_price": "3000",
      "comment": "Második cikk megjegyzése"
    }
  ]
}

Response

SalesInvoice