GET v1/{organizationId}/invoices/{guid}

Get invoice as json or pdf. Define the Accept header of your request to either 'application/json' or 'application/octet-stream'. PDF's can only be generated from booked invoices.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
guid

globally unique identifier

Required

organizationId

string

None.

Body Parameters

Response Information

Resource Description

>Returns the invoice as json or a stream depending on the Accept header.

Invoice
NameDescriptionType
PaymentDate

The invoice's payment date. This should be in the format YYYY-MM-DD e.g. 2015-12-02

string
PaymentStatus

An invoice can have payment status Draft, Booked, Paid, OverPaid or Overdue

string
PaymentConditionNumberOfDays

Number of days until payment deadline.

integer
PaymentConditionType

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

string
FikCode

FIK code (Fælles Indbetalings Kort)

string
Status

An sales voucher can have status Draft or Booked

string
ContactGuid

Dinero contact guid.

globally unique identifier
Guid

The guid of the voucher

globally unique identifier
TimeStamp

Timestamp of version. To avoid concurrency issues.

string
CreatedAt

Time of creation

date
UpdatedAt

Time of last update

date
DeletedAt

Time of deletion. Null unless the object is deleted.

date
Number

The number of the voucher.

integer
ContactName

Contact name

string
ShowLinesInclVat

If true, the user prefers the invoice to be displayed with lines incl vat.

boolean
TotalExclVat

Total amount without vat

decimal number
TotalVatableAmount

Total amount to calculate the vat from

decimal number
TotalInclVat

Total amount incl. vat

decimal number
TotalNonVatableAmount

Total vat free amount

decimal number
TotalVat

Total vat amount

decimal number
TotalLines

Total lines. SubTotal, Vat and Total. Only lines valid for display in the current context are returned.

Collection of TotalLine
Currency

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...

string
Language

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

string
ExternalReference

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
Description

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

string
Comment

User supplied comment on the voucher

string
Date

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

string
ProductLines

User supplied invoice lines. Minimum one.

Collection of InvoiceLine
Address

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

string
Sample:
{
  "PaymentDate": "2015-12-02",
  "PaymentStatus": "Overdue",
  "PaymentConditionNumberOfDays": 8,
  "PaymentConditionType": "Netto",
  "FikCode": "+71<000000016460909+12345678<",
  "Status": "Draft",
  "ContactGuid": "d021f9e7-3bb1-4a50-9148-4cf844706867",
  "Guid": "874d5ee3-1dc5-435c-a5a4-90a87c94030c",
  "TimeStamp": "00000000020A5EA8",
  "CreatedAt": "2018-12-19T06:37:11.0697779+00:00",
  "UpdatedAt": "2018-12-19T06:37:11.0697779+00:00",
  "DeletedAt": "2018-12-19T06:37:11.0697779+00:00",
  "Number": 12,
  "ContactName": "Donald Duck",
  "ShowLinesInclVat": false,
  "TotalExclVat": 200.0,
  "TotalVatableAmount": 200.0,
  "TotalInclVat": 250.0,
  "TotalNonVatableAmount": 0.0,
  "TotalVat": 50.0,
  "TotalLines": [
    {
      "Type": "SubTotal",
      "TotalAmount": 200.0,
      "Position": 0,
      "Label": "Subtotal"
    },
    {
      "Type": "SubTotal",
      "TotalAmount": 200.0,
      "Position": 0,
      "Label": "Subtotal"
    }
  ],
  "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": [
    {
      "AccountName": "Bank",
      "BaseAmountValue": 20.0,
      "BaseAmountValueInclVat": 25.0,
      "TotalAmount": 100.0,
      "TotalAmountInclVat": 125.0,
      "ProductGuid": "d2898f8a-40bb-42e7-af70-2fd60d1b0d89",
      "Description": "Flowers",
      "Comments": "Smells good",
      "Quantity": 5.0,
      "AccountNumber": 1000,
      "Unit": "parts",
      "Discount": 10.0,
      "LineType": "Product"
    },
    {
      "AccountName": "Bank",
      "BaseAmountValue": 20.0,
      "BaseAmountValueInclVat": 25.0,
      "TotalAmount": 100.0,
      "TotalAmountInclVat": 125.0,
      "ProductGuid": "d2898f8a-40bb-42e7-af70-2fd60d1b0d89",
      "Description": "Flowers",
      "Comments": "Smells good",
      "Quantity": 5.0,
      "AccountNumber": 1000,
      "Unit": "parts",
      "Discount": 10.0,
      "LineType": "Product"
    }
  ],
  "Address": "Test Road 3 2100 Copenhagen Denmark"
}