v2

latestSwagger 2.02026-08-0138140265.1 KB

PurchaseInvoices

DEPRECATED. Get Purchase invoice data as JSON

DEPRECATED. Use the /api/v2/received_documents endpoint. Get a specific PurchaseInvoice, in JSON format.

get/purchase_invoices/{guid}

Path parameters

guidstring uuid required

The guid of the purchase invoice, from the webhook.

Query parameters

pmvstring

DEPRECATED. The PaymentMeans version. The default (and deprecated) version 1.0 will give BankPaymentMean, DirectDebitPaymentMean, CardPaymentMean, NppPaymentMean, SeBankGiroPaymentMean, SePlusGiroPaymentMean, SgCardPaymentMean, SgGiroPaymentMean, SgPaynowPaymentMean.

Version 2.0 deprecates BankPaymentMean (now CreditTransferPaymentMean), CardPaymentMean (now CreditCardPaymentMean), NppPaymentMean (now AunzNppPayidPaymentMean), SeBankGiroPaymentMean (now SeBankgiroPaymentMean -- note the lower 'g' in 'bankgiro'). It also adds OnlinePaymentServicePaymentMean, StandingAgreementPaymentMean, AunzNppPaytoPaymentMean, AunzBpayPaymentMean, AunzPostbillpayPaymentMean, AunzUriPaymentMean.

versionstring

The JSON content version date. The default is '1970-01-01' meaning you get all deprecated elements since nothing was deprecated before that ;). If you do not want deprecated elements, use a later date. Do not use a dynamic date, because that means when we deprecate elements they will disappear from our responses.

Response

Success

external_user_idstring

Deprecated. Used for the embedded portal retrieval service. The external_user_id you provided when the ShopAccount was created.

external_keystring

Deprecated. Used for accountants. The id you specified for the organization.

documentstring

DEPRECATED. Use the new atatchments array.

invoice_type'invoice' | 'creditnote' | 'correctioninvoice'

The type of invoice.

vat_reverse_chargeboolean

DEPRECATED - This is now part of each invoice line.

amount_including_vatnumber

DEPRECATED - Use amount_including_tax.

allowance_chargenumber

DEPRECATED - Use the allowance_charges array.

payment_means_payment_idstring

DEPRECATED - use the payment_id property in the payment_means_array

guidstring uuid

The GUID of the invoice

legal_entity_idinteger

The id of the LegalEntity the invoice was received for.

system_generated_primary_imageboolean

Whether or not the document image (PDF) was generated by Storecove. If true, it means the invoice was received without any attachments and Storecove generated one for you. If false, the invoice will contain at least one attachment, which was received from the invoice sender.

document_type'invoice'

The type of document. Only "invoice" for now.

sub_type'invoice' | 'creditnote' | 'correctioninvoice'

The subtype of document.

source'peppol' | 'script' | 'supplier' | 'email'

The source the invoice was received from.

tax_systemstring

The tax system of the invoice. Either tax_line_percentages or tax_line_amounts. The first tax system means the invoice lines contain only the tax percentages and the tax amounts are included only in the tax subtotals at the invoice level and so are only calculated at the invoice level. The tax system tax_line_amounts means that in addition to the percentage, each invoice line also contains the tax amount. The tax subtotals at the invoice level are calculated as the sum of the tax of the invoice lines. The distinction between the two tax systems has has implications for rounding.

invoice_numberstring

The invoicenumber.

issue_datestring

The date the invoice was issued. Format "YYYY-MM-DD".

tax_point_datestring

The date the invoice was issued for tax purposes. In most countries MUST match the issue_date. Format "YYYY-MM-DD".

tax_point_date_code'3' | '35' | '432'

The code describing which date is used as the tax point date. Supported values: 3 (invoice issue date), 35 (actual delivery date), 432 (paid to date).

due_datestring

The date the invoice must be payed by. Format "YYYY-MM-DD".

document_currency_codestring

The ISO 4217 currency for the invoice.

period_startstring

The start date of the period this invoice relates to. Format "YYYY-MM-DD".

period_endstring

The end date of the period this invoice relates to. Format "YYYY-MM-DD".

notestring

The invoice level note.

buyer_referencestring

Reference provided by the buyer. Used for routing.

billing_referencestring

Reference to the previous invoice this invoice relates to.

contract_document_referencestring

Reference to the contract.

order_referencestring

Reference to the order. Used for matching the invoice to an order.

project_referencestring

Reference to the project.

accounting_coststring

The accounting cost code.

payment_terms_notestring

A textual description of the payment terms.