Fetch invoice

Fetch a invoice to get total, line sums and payment date calculations.

Query parameters

NameDescription
organizationId string

Request model

Model of the invoice.
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

Returns the invoice as json.

NameDescription
PaymentDate string

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

Number of days until payment deadline.
PaymentConditionType string

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

Dinero contact guid.
Number integer

The number of the voucher.
ContactName string

Contact name
ShowLinesInclVat boolean

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

Total amount without vat
TotalVatableAmount decimal number

Total amount to calculate the vat from
TotalInclVat decimal number

Total amount incl. vat
TotalNonVatableAmount decimal number

Total vat free amount
TotalVat decimal number

Total vat amount
TotalLines TotalLine[] Show model
NameDescription
Type string

The type of total line. Options are: SubTotal, SubTotalWithVat, SubTotalWithoutVat, Vat and Total.
TotalAmount decimal number

Value to display
Position integer

Position in which it should be displayed, if part of a list of total lines. 0-based index.
Label string

Label text

Total lines. SubTotal, Vat and Total. Only lines valid for display in the current context are returned.
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
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 InvoiceLine[] Show model
NameDescription
AccountName string

Name of the Account
BaseAmountValue decimal number

Amount excl. VAT
BaseAmountValueInclVat decimal number

Base amount incl. VAT
TotalAmount decimal number

Total of the line excl VAT
TotalAmountInclVat decimal number

Total of the line incl VAT
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.
Address string

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

 
v1/{organizationId}/invoices/fetch

Requests Formats

{
  "PaymentConditionNumberOfDays": 8,
  "PaymentConditionType": "Netto",
  "ContactGuid": "1adb675d-b9f8-4ca7-be4f-416ea5aad989",
  "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": "7bda11e9-c30d-4fe4-8219-6a090e3302ba",
      "Description": "Flowers",
      "Comments": "Smells good",
      "Quantity": 5.0,
      "AccountNumber": 1000,
      "Unit": "parts",
      "Discount": 10.0,
      "LineType": "Product"
    },
    {
      "BaseAmountValue": 20.0,
      "ProductGuid": "7bda11e9-c30d-4fe4-8219-6a090e3302ba",
      "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

{
  "PaymentDate": "2015-12-02",
  "PaymentConditionNumberOfDays": 8,
  "PaymentConditionType": "Netto",
  "ContactGuid": "be59b727-dbc3-4092-afc8-4e2a849dae4d",
  "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": "36449a7f-0226-4dea-acb3-9aad7eaa147b",
      "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": "36449a7f-0226-4dea-acb3-9aad7eaa147b",
      "Description": "Flowers",
      "Comments": "Smells good",
      "Quantity": 5.0,
      "AccountNumber": 1000,
      "Unit": "parts",
      "Discount": 10.0,
      "LineType": "Product"
    }
  ],
  "Address": "Test Road 3 2100 Copenhagen Denmark"
}