Create a new invoice

curl --request POST \
  --url http://localhost/api/invoices \
  --header 'Content-Type: application/json' \
  --data '
{
  "identification": {
    "seller": {
      "pink_id": "<string>",
      "gln": "<string>"
    },
    "buyer": {
      "pink_id": "<string>",
      "gln": "<string>"
    },
    "pink_id": "<string>",
    "seller_invoice_id": "<string>"
  },
  "issue_date": "2023-11-07T05:31:56Z",
  "currency": "EUR",
  "buyer": {
    "name": "<string>",
    "address": {
      "line1": "<string>",
      "city": "<string>",
      "postal_code": "<string>",
      "country": "AT",
      "line2": "<string>"
    },
    "identification": {
      "gln": "<string>",
      "tax_id": "<string>"
    }
  },
  "invoice_recipient": {
    "name": "<string>",
    "address": {
      "line1": "<string>",
      "city": "<string>",
      "postal_code": "<string>",
      "country": "AT",
      "line2": "<string>"
    },
    "identification": {
      "gln": "<string>",
      "tax_id": "<string>"
    }
  },
  "supplier": {
    "name": "<string>",
    "address": {
      "line1": "<string>",
      "city": "<string>",
      "postal_code": "<string>",
      "country": "AT",
      "line2": "<string>"
    },
    "identification": {
      "gln": "<string>",
      "tax_id": "<string>"
    }
  },
  "lines": [
    {
      "line_number": "<string>",
      "product_id": "<string>",
      "product_name": "<string>",
      "quantity": 123,
      "unit": "pc",
      "references": [
        {
          "identification": {
            "type": "DELIVERY_NOTE",
            "vendor_id": "<string>",
            "pink_id": "<string>"
          },
          "line_number": 123
        }
      ],
      "tax_details": [
        {
          "rate": 123,
          "amount": {
            "amount": 123,
            "currency": "EUR"
          },
          "type": "<string>",
          "taxable_amount": {
            "amount": 123,
            "currency": "EUR"
          }
        }
      ],
      "delivery_date": "2023-11-07T05:31:56Z",
      "free_text": "<string>",
      "unit_price": {
        "amount": 123,
        "currency": "EUR"
      },
      "net_amount": {
        "amount": 123,
        "currency": "EUR"
      },
      "total_amount": {
        "amount": 123,
        "currency": "EUR"
      }
    }
  ],
  "total_amount": {
    "amount": 123,
    "currency": "EUR"
  },
  "net_amount": {
    "amount": 123,
    "currency": "EUR"
  },
  "tax_details": [
    {
      "rate": 123,
      "amount": {
        "amount": 123,
        "currency": "EUR"
      },
      "type": "<string>",
      "taxable_amount": {
        "amount": 123,
        "currency": "EUR"
      }
    }
  ],
  "period_start": "2023-11-07T05:31:56Z",
  "period_end": "2023-11-07T05:31:56Z",
  "payment_due_date": "2023-11-07T05:31:56Z",
  "payment_terms": "<string>"
}
'

{
  "message": "Invoice created successfully",
  "transmission_id": "<string>",
  "": "<string>"
}

POST

invoices

curl --request POST \
  --url http://localhost/api/invoices \
  --header 'Content-Type: application/json' \
  --data '
{
  "identification": {
    "seller": {
      "pink_id": "<string>",
      "gln": "<string>"
    },
    "buyer": {
      "pink_id": "<string>",
      "gln": "<string>"
    },
    "pink_id": "<string>",
    "seller_invoice_id": "<string>"
  },
  "issue_date": "2023-11-07T05:31:56Z",
  "currency": "EUR",
  "buyer": {
    "name": "<string>",
    "address": {
      "line1": "<string>",
      "city": "<string>",
      "postal_code": "<string>",
      "country": "AT",
      "line2": "<string>"
    },
    "identification": {
      "gln": "<string>",
      "tax_id": "<string>"
    }
  },
  "invoice_recipient": {
    "name": "<string>",
    "address": {
      "line1": "<string>",
      "city": "<string>",
      "postal_code": "<string>",
      "country": "AT",
      "line2": "<string>"
    },
    "identification": {
      "gln": "<string>",
      "tax_id": "<string>"
    }
  },
  "supplier": {
    "name": "<string>",
    "address": {
      "line1": "<string>",
      "city": "<string>",
      "postal_code": "<string>",
      "country": "AT",
      "line2": "<string>"
    },
    "identification": {
      "gln": "<string>",
      "tax_id": "<string>"
    }
  },
  "lines": [
    {
      "line_number": "<string>",
      "product_id": "<string>",
      "product_name": "<string>",
      "quantity": 123,
      "unit": "pc",
      "references": [
        {
          "identification": {
            "type": "DELIVERY_NOTE",
            "vendor_id": "<string>",
            "pink_id": "<string>"
          },
          "line_number": 123
        }
      ],
      "tax_details": [
        {
          "rate": 123,
          "amount": {
            "amount": 123,
            "currency": "EUR"
          },
          "type": "<string>",
          "taxable_amount": {
            "amount": 123,
            "currency": "EUR"
          }
        }
      ],
      "delivery_date": "2023-11-07T05:31:56Z",
      "free_text": "<string>",
      "unit_price": {
        "amount": 123,
        "currency": "EUR"
      },
      "net_amount": {
        "amount": 123,
        "currency": "EUR"
      },
      "total_amount": {
        "amount": 123,
        "currency": "EUR"
      }
    }
  ],
  "total_amount": {
    "amount": 123,
    "currency": "EUR"
  },
  "net_amount": {
    "amount": 123,
    "currency": "EUR"
  },
  "tax_details": [
    {
      "rate": 123,
      "amount": {
        "amount": 123,
        "currency": "EUR"
      },
      "type": "<string>",
      "taxable_amount": {
        "amount": 123,
        "currency": "EUR"
      }
    }
  ],
  "period_start": "2023-11-07T05:31:56Z",
  "period_end": "2023-11-07T05:31:56Z",
  "payment_due_date": "2023-11-07T05:31:56Z",
  "payment_terms": "<string>"
}
'

{
  "message": "Invoice created successfully",
  "transmission_id": "<string>",
  "": "<string>"
}

Body

application/json

Invoice

identification

InvoiceIdentification · object

required

Invoice identification

Show child attributes

identification.seller

PartnerIdentification · object

required

Seller identification

Show child attributes

identification.seller.pink_id

string

Internal platform UUID

identification.seller.gln

string

Global Location Number (GLN)

identification.buyer

PartnerIdentification · object

required

Buyer identification

Show child attributes

identification.buyer.pink_id

string

Internal platform UUID

identification.buyer.gln

string

Global Location Number (GLN)

identification.pink_id

string

Internal platform UUID

identification.seller_invoice_id

string

Invoice number from the source system

issue_date

string<date-time>

required

Invoice date

currency

enum<string>

required

Available options:

EUR,

USD,

GBP

buyer

InvoiceParty · object

required

Buyer information

Show child attributes

buyer.name

string

required

buyer.address

Address · object

required

Show child attributes

buyer.address.line1

string

required

Address line 1 (e.g., street name and number)

buyer.address.city

string

required

City name

buyer.address.postal_code

string

required

buyer.address.country

enum<string>

required

Available options:

AT,

BE,

BG,

HR,

CY,

CZ,

DK,

EE,

FI,

FR,

DE,

GR,

HU,

IE,

IT,

LV,

LT,

LU,

MT,

NL,

PL,

PT,

RO,

SK,

SI,

ES,

SE,

AL,

AD,

BY,

BA,

IS,

LI,

MD,

MC,

ME,

MK,

NO,

RU,

SM,

RS,

CH,

TR,

UA,

GB,

VA

buyer.address.line2

string

Address line 2 (e.g., apartment, suite, unit, building)

buyer.identification

InvoicePartyIdentification · object

Show child attributes

buyer.identification.gln

string

Global Location Number (GLN)

buyer.identification.tax_id

string

Tax identification number (e.g., VAT number)

invoice_recipient

InvoiceParty · object

required

Invoice recipient information

Show child attributes

invoice_recipient.name

string

required

invoice_recipient.address

Address · object

required

Show child attributes

invoice_recipient.address.line1

string

required

Address line 1 (e.g., street name and number)

invoice_recipient.address.city

string

required

City name

invoice_recipient.address.postal_code

string

required

invoice_recipient.address.country

enum<string>

required

Available options:

AT,

BE,

BG,

HR,

CY,

CZ,

DK,

EE,

FI,

FR,

DE,

GR,

HU,

IE,

IT,

LV,

LT,

LU,

MT,

NL,

PL,

PT,

RO,

SK,

SI,

ES,

SE,

AL,

AD,

BY,

BA,

IS,

LI,

MD,

MC,

ME,

MK,

NO,

RU,

SM,

RS,

CH,

TR,

UA,

GB,

VA

invoice_recipient.address.line2

string

Address line 2 (e.g., apartment, suite, unit, building)

invoice_recipient.identification

InvoicePartyIdentification · object

Show child attributes

invoice_recipient.identification.gln

string

Global Location Number (GLN)

invoice_recipient.identification.tax_id

string

Tax identification number (e.g., VAT number)

supplier

InvoiceParty · object

required

Supplier information

Show child attributes

supplier.name

string

required

supplier.address

Address · object

required

Show child attributes

supplier.address.line1

string

required

Address line 1 (e.g., street name and number)

supplier.address.city

string

required

City name

supplier.address.postal_code

string

required

supplier.address.country

enum<string>

required

Available options:

AT,

BE,

BG,

HR,

CY,

CZ,

DK,

EE,

FI,

FR,

DE,

GR,

HU,

IE,

IT,

LV,

LT,

LU,

MT,

NL,

PL,

PT,

RO,

SK,

SI,

ES,

SE,

AL,

AD,

BY,

BA,

IS,

LI,

MD,

MC,

ME,

MK,

NO,

RU,

SM,

RS,

CH,

TR,

UA,

GB,

VA

supplier.address.line2

string

Address line 2 (e.g., apartment, suite, unit, building)

supplier.identification

InvoicePartyIdentification · object

Show child attributes

supplier.identification.gln

string

Global Location Number (GLN)

supplier.identification.tax_id

string

Tax identification number (e.g., VAT number)

lines

InvoiceLine · object[]

required

Show child attributes

lines.line_number

string

required

lines.product_id

string

required

lines.product_name

string

required

lines.quantity

number

required

lines.unit

enum<string>

required

Available options:

pc,

box,

ctn,

plt,

pack,

bundle,

kg,

g,

mg,

t,

l,

ml,

m3

lines.references

InvoiceLineReference · object[]

required

Show child attributes

lines.references.identification

InvoiceLineReferenceIdentification · object

required

Show child attributes

lines.references.identification.type

enum<string>

required

Available options:

DELIVERY_NOTE,

ORDER

lines.references.identification.vendor_id

string

required

lines.references.identification.pink_id

string | null

required

lines.references.line_number

integer | null

required

lines.tax_details

TaxDetail · object[]

required

Show child attributes

lines.tax_details.rate

number

required

Tax rate percentage

lines.tax_details.amount

Price · object

required

Show child attributes

lines.tax_details.amount.amount

integer

required

Amount in the smallest currency unit (e.g., cents for EUR)

lines.tax_details.amount.currency

enum<string>

required

Available options:

EUR,

USD,

GBP

lines.tax_details.type

string

Tax type (e.g., VAT)

lines.tax_details.taxable_amount

Price · object

Taxable basis amount

Show child attributes

lines.tax_details.taxable_amount.amount

integer

required

Amount in the smallest currency unit (e.g., cents for EUR)

lines.tax_details.taxable_amount.currency

enum<string>

required

Available options:

EUR,

USD,

GBP

lines.delivery_date

string<date-time>

lines.free_text

string

lines.unit_price

Price · object

Show child attributes

lines.unit_price.amount

integer

required

Amount in the smallest currency unit (e.g., cents for EUR)

lines.unit_price.currency

enum<string>

required

Available options:

EUR,

USD,

GBP

lines.net_amount

Price · object

Show child attributes

lines.net_amount.amount

integer

required

Amount in the smallest currency unit (e.g., cents for EUR)

lines.net_amount.currency

enum<string>

required

Available options:

EUR,

USD,

GBP

lines.total_amount

Price · object

Show child attributes

lines.total_amount.amount

integer

required

Amount in the smallest currency unit (e.g., cents for EUR)

lines.total_amount.currency

enum<string>

required

Available options:

EUR,

USD,

GBP

total_amount

PriceRequest · object

required

Show child attributes

total_amount.amount

integer

required

Amount in the smallest currency unit (e.g., cents for EUR)

total_amount.currency

enum<string>

required

Available options:

EUR,

USD,

GBP

net_amount

PriceRequest · object

required

Show child attributes

net_amount.amount

integer

required

Amount in the smallest currency unit (e.g., cents for EUR)

net_amount.currency

enum<string>

required

Available options:

EUR,

USD,

GBP

tax_details

TaxDetail · object[]

required

Show child attributes

tax_details.rate

number

required

Tax rate percentage

tax_details.amount

Price · object

required

Show child attributes

tax_details.amount.amount

integer

required

Amount in the smallest currency unit (e.g., cents for EUR)

tax_details.amount.currency

enum<string>

required

Available options:

EUR,

USD,

GBP

tax_details.type

string

Tax type (e.g., VAT)

tax_details.taxable_amount

Price · object

Taxable basis amount

Show child attributes

tax_details.taxable_amount.amount

integer

required

Amount in the smallest currency unit (e.g., cents for EUR)

tax_details.taxable_amount.currency

enum<string>

required

Available options:

EUR,

USD,

GBP

period_start

string<date-time>

Invoice period start date

period_end

string<date-time>

Invoice period end date

payment_due_date

string<date-time>

payment_terms

string

Response

message

string

required

Example:

"Invoice created successfully"

transmission_id

string

required

string

Create a new delivery note Create a new order

⌘I

Guides

Endpoints

Create a new invoice

Body

Response