GET v1/{organizationId}/tradeoffers/{guid}

Get tradeoffer as json or pdf. Define the Accept header of your request to either 'application/json' or 'application/octet-stream'.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
guid

Guid of the tradeoffer

globally unique identifier

Required

organizationId

string

None.

Body Parameters

Response Information

Resource Description

Returns the trade offer as json or a stream depending on the Accept header.

TradeOffer
NameDescriptionType
Guid

The guid of the voucher

globally unique identifier
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
TotalInclVat

Total amount incl. vat

decimal number
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
ContactName

Contact name

string
Number

The number of the voucher.

integer
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
HasGeneratedAnyVouchers

OBSOLETE: Use Status instead. Equivalent of Status == Invoiced. Is true if any vouchers has been generated based on this trade offer.

boolean
ContactGuid

Dinero contact guid.

globally unique identifier
Status

Status of the trade offer. Possible values are Draft, Invoiced, CustomerAccepted, CustomerDeclined, UserAccepted, UserDeclined

string
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
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
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
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
Comment

User supplied comment on the voucher

string
ProductLines

User supplied invoice lines. Minimum one.

Collection of TradeOfferLine
Address

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

string
Sample:
{
  "HasGeneratedAnyVouchers": true,
  "ContactGuid": "185f196c-a07e-4b4c-b303-1d09140d5631",
  "Status": "Invoiced",
  "Guid": "15d76901-bd73-43d2-8534-7e73dac9c0f2",
  "TimeStamp": "00000000020A5EA8",
  "CreatedAt": "2018-12-19T05:24:30.5520373+00:00",
  "UpdatedAt": "2018-12-19T05:24:30.5520373+00:00",
  "DeletedAt": "2018-12-19T05:24:30.5520373+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": "1f355070-d944-473b-91b3-dc9b86863b64",
      "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": "1f355070-d944-473b-91b3-dc9b86863b64",
      "Description": "Flowers",
      "Comments": "Smells good",
      "Quantity": 5.0,
      "AccountNumber": 1000,
      "Unit": "parts",
      "Discount": 10.0,
      "LineType": "Product"
    }
  ],
  "Address": "Test Road 3 2100 Copenhagen Denmark"
}