Create invoice

Saves invoice.

Query parameters

NameDescription
organizationId string

Request model

Model of the invoice to save.
NameDescription
PaymentConditionNumberOfDays integer

Number of days until payment deadline. If PaymentConditionNumberOfDays AND PaymentConditionType is left empty they will default to the contacts default payment conditions.

PaymentConditionType string

Type of payment condition. Valid types are: Netto, NettoCash, CurrentMonthOut, or Paid. Note that if you use NettoCash or Paid, PaymentConditionNumberOfDays should be null.

ContactGuid globally unique identifier

Dinero contact guid.

ShowLinesInclVat boolean

If your user (or your system) prefers to provide the line amounts incl. VAT, then this property should be set to true. All voucher lines will be assumed to have amounts incl VAT. If your lines are excl VAT, you do not need to set this property. It will defaults to false.

Currency string

The currency used on the voucher. Defaults to DKK if null. Dinero will assign days date currency rate for the given currency. Currencies are given i format: DKK, EUR, USD ect...

Language string

The language to be used in the voucher. Available languages are 'da-DK' and 'en-GB'. Defaults to 'da-DK'.

ExternalReference string

Your external id This can be used for ID'ing in external apps/services e.g. a web shop. The maximum length is 128 characters

String length: inclusive between 0 and 128

Description string

User supplied description of the voucher e.g. 'Custom Invoice description'. Defaults to document type e.g. 'Invoice', 'Offer', 'Creditnote' using the selected language.

Comment string

User supplied comment on the voucher

Date string

The date of the creation/issuing. This should be in the format YYYY-MM-DD e.g. 2015-12-02. Defaults to today.

ProductLines InvoiceLineCreate[] Show model
NameDescription
BaseAmountValue decimal number

Base amount. As default without VAT. If you want to use amounts incl vat, the setting 'ShowLinesInclVat' should be set to true on the voucher containing the lines.

ProductGuid globally unique identifier

The guid of product. If product guid is set, description should be null.

Description string

A description of the product. If no ProductGuid, this field is required. This field will always have a value on the read model, even if a ProductGuid is set.

Comments string

User supplied comment

Quantity decimal number

Quantity

AccountNumber integer

Account number

Unit string

Product unit. Available unit types: hours, parts, km, day, week, month, kilogram, cubicMetre, set, litre, box, case, carton, metre, package, shipment, squareMetre, session, tonne.

Discount decimal number

Discount for the current line. Specified in percentage from 0 to 100.

LineType string

Type. Either Product or Text line. Text is used for creating bold lines only with text displayed, these lines are purely visual and have no effect on the voucher. Text lines should only contain a description. Product lines are the actual lines of the invoice used for accounting and total calculations.

User supplied invoice lines. Minimum one.

Required

Address string

Contact address (linebreaks are allowed '\n'). When null is specified the address defaults to the contacts address.

Returns

201 (created) if the invoice has been successfully saved.

NameDescription
Guid globally unique identifier

The id of the object

TimeStamp string

Timestamp of version. To avoid concurrency issues.

v1/{organizationId}/invoices

Requests Formats

{
  "PaymentConditionNumberOfDays": 8,
  "PaymentConditionType": "Netto",
  "ContactGuid": "6db849f3-ed03-4be0-b733-a69919e1067d",
  "ShowLinesInclVat": false,
  "Currency": "DKK",
  "Language": "en-GB",
  "ExternalReference": "Fx. WebshopSpecialId: 42",
  "Description": "Description of document type. Fx.: invoice, credit note or offer",
  "Comment": "Very very important comment",
  "Date": "2015-12-02",
  "ProductLines": [
    {
      "BaseAmountValue": 20.0,
      "ProductGuid": "fc7ec6b3-85df-4da9-aef9-43475927d185",
      "Description": "Flowers",
      "Comments": "Smells good",
      "Quantity": 5.0,
      "AccountNumber": 1000,
      "Unit": "parts",
      "Discount": 10.0,
      "LineType": "Product"
    },
    {
      "BaseAmountValue": 20.0,
      "ProductGuid": "fc7ec6b3-85df-4da9-aef9-43475927d185",
      "Description": "Flowers",
      "Comments": "Smells good",
      "Quantity": 5.0,
      "AccountNumber": 1000,
      "Unit": "parts",
      "Discount": 10.0,
      "LineType": "Product"
    }
  ],
  "Address": "Test Road 3 2100 Copenhagen Denmark"
}

Response Formats

{
  "Guid": "e311cd3b-0799-46e4-8556-96e4fa62bdcf",
  "TimeStamp": "00000000020A5EA8"
}