Storecove API Documentation

code
optional

The buyer’s accounting cost centre for this invoice(line), expressed as a code
Minimum length : 1

string

list
optional

The identification of a list of codes.
Minimum length : 1

string

listAgency
optional

An agency that maintains one or more lists of codes.
Minimum length : 1

string

listVersion
optional

The version of the list of codes.
Minimum length : 1

string

accountId
optional

The account id you assigned to the customer.

string

party
required

Party

party
optional

SupplierParty

city
optional

The name of the city.
Minimum length : 2

string

country
required

Country

county
optional

An optional county name.

string

department
optional

The department

string

number
optional

This number will be added to the street1 element. The number can be provided in this field OR in the street1 field, but not in both.

string

postbox
optional

The postbox number

string

street1
optional

The street name. The number can be provided in this fiedl OR in the number field, but not in both.
Minimum length : 2

string

street2
optional

The second street field. Use this if you used the first field for the building name.

string

zip
optional

The zipcode/postalzone.
Minimum length : 2

string

amountExcludingVat
required

The amount for the allowance charge, excluding VAT

number

reason
optional

The reason for the allowance charge, free text
Default : "Agreed settlement"

string

reasonCode
optional

The reason code for the allowance charge. Uses list http://www.unece.org/trade/untdid/d12a/tred/tred4465.htm , defaults to 1 - Agreed settlement
Default : "1"

string

tax
required

The tax for this allowance charge.

Tax

amount
required

The amount of VAT. Should equal percentage x amountExcludingVat. A difference of 5 cents or 1% between the calculated value and the provided value is allowed.

number

country
required

Country

percentage
required

The percentage VAT. This should be a valid VAT percentage in the country at the time of the issueDate of this invoice.

number

accountId
optional

The account id you assigned to the customer.

string

party
required

Party

email
optional

string (email)

firstName
optional

string

lastName
optional

string

phone
optional

Only supported for AccountingSupplierParty.

string

actualDate
optional

The actual date of the delivery.
Pattern : "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"

string

location
optional

location

quantity
optional

The quantity of the delivery.

number

address
optional

Address

id
optional

The location identifier.
Minimum length : 2

string

schemeAgencyId
optional

The schemeAgencyId of the location identifier (e.g. 'ZZZ')

string

schemeId
optional

The schemeId of the location identifier (e.g. 'EAN')

string

details
optional

string

source
optional

string

accountingCost
optional

The buyer’s accounting cost centre for this invoice, expressed as text.
Minimum length : 1

string

accountingCostCode
optional

AccountingCostCode

accountingCustomerParty
required

The party the invoice is sent to.

AccountingCustomerParty

accountingSupplierParty
optional

The party sending the invoice. Most data for the AccountingSupplierParty is taken from the Storecove database, where your sender identity resides and has been validated. However, we provide a limited number of fields (mainly contact fields) here that you can specify on an invoice-by-invoice basis. Contact us if you want to use this feature.

AccountingSupplierParty

allowanceCharges
optional

An array of allowance charges.

< AllowanceCharge > array

amountIncludingVat
required

amountIncludingVat is important because of rounding differences. In many invoices, the sum of the line item amounts excluding VAT and the VAT amounts is not equal to first summing the line items without VAT, and then applying VAT. The difference is automatically calculated and included in the electronic invoice, so the receiving accounting package can process the electronic invoice without problems.

number

billingReference
optional

A reference to a commercial invoice or corrective invoice of which the current invoice is a correction. This field is mandatory when sending invoiceType 384.

string

buyerCustomerParty
optional

The buyer party.

BuyerCustomerParty

buyerReference
optional

A reference provided by the buyer used for internal routing of the document.

string

contractDocumentReference
optional

A reference to a contract or framework agreement that this invoice relates to.

string

delivery
optional

The delivery of the invoice.

Delivery

documentCurrencyCode
optional

The documentCurrencyCode is the currency for the entire invoice. We currently do not support invoices in multiple currencies. If left out, will default to EUR

CurrencyCode

dueDate
optional

Format: yyyy-mm-dd.
Pattern : "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"

string

invoiceLines
required

An array of invoice lines.

< InvoiceLine > array

invoiceNumber
required

The invoice number you assigned to the invoice. The invoiceNumber should be unique for the legalEntityId and year of the issueDate. This means invoice numbers can be reused in different years, as is customary in some countries.
Minimum length : 1

string

invoicePeriod
optional

The period (or specific date) to which the invoice applies. Format: yyyy-mm-dd - yyyy-mm-dd.
Pattern : "^[0-9]{4}-[0-9]{2}-[0-9]{2} - [0-9]{4}-[0-9]{2}-[0-9]{2}$"

string

invoiceType
optional

Use 380 for a regular invoice, 381 for a credit invoice, 384 for a corrective invoice. Note that invoiceType 381 must be for a positive amount! In case of invoiceType 384, the billingReference field must contain the invoiceNumber of the invoice being corrected.
Default : "380"

enum (380, 381, 384)

issueDate
required

Format: yyyy-mm-dd.
Pattern : "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"

string

note
optional

A note to add to the invoice

string

orderReference
optional

A reference to an order for this invoice, assigned by the buyer.

string

paymentMeansCode
optional

A code from the UNCL4461 list (http://docs.peppol.eu/poacc/billing/3.0/codelist/UNCL4461/). You should probably omit this or use 31.
Default : "31"

string

paymentMeansIban
optional

The IBAN the amount payable should be transferred to

string

paymentMeansPaymentId
optional

The payment id that you will use to match the payment against the invoice.

string

projectReference
optional

Information about the project this invoice relates to.

string

salesOrderId
optional

A reference to an order for this invoice, assigned by the seller.

string

taxExemptReason
optional

The reason no tax is present on the invoice. allowed: export, reverse_charge, zero_rated. Note that this is an invoice level field and you cannot currently specify it per invoice line.

enum (export, reverse_charge, zero_rated)

taxPointDate
optional

The tax date is the date on which the supply of goods or of services was made or completed or the date on which the payment on account was made insofar as that date can be determined and differs from the date of the issue of the invoice. EU 2006-112 Article 226 Point 7. Note: For the Dutch TAX authorities the tac date should be the same as the issue date.
Pattern : "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"

string

ublExtensions
optional

An array of ubl extensions.

< string > array

vatReverseCharge
optional

DEPRECTATED. Use taxExemptReason.
Default : false

boolean

accountingCost
optional

The buyer’s accounting cost centre for this invoice line, expressed as text.
Minimum length : 1

string

accountingCostCode
optional

AccountingCostCode

allowanceCharge
optional

The discount or surcharge on this item. Should be negative for discounts

number

amountExcludingVat
required

The amount excluding VAT. Should equal quantity x itemPrice + allowanceCharge. A difference of 5 cents or 1% between the calculated value and the provided value is allowed.

number

delivery
optional

The delivery of the invoice line.

Delivery

description
optional

The description for this invoice line.
Minimum length : 1

string

invoicePeriod
optional

The period (or specific date) to which the invoice line applies. Format: yyyy-mm-dd - yyyy-mm-dd.
Pattern : "^[0-9]{4}-[0-9]{2}-[0-9]{2} - [0-9]{4}-[0-9]{2}-[0-9]{2}$"

string

itemPrice
optional

The price per item (may be fractional)

number

name
optional

A short name for this invoice line. If not provided, it will be taken from description and description will be set to an emtpy string.
Minimum length : 1

string

quantity
optional

The number of items (may be fractional).

number

quantityUnitCode
optional

A unit code from UNECE Rec20. The complete list can be found at http://www.datypic.com/sc/ubl20/a-unitCode-4.html
Default : "C62"

enum (04, 05, 08, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 40, 41, 43, 44, 45, 46, 47, 48, 53, 54, 56, 57, 58, 59, 60, 61, 62, 63, 64, 66, 69, 71, 72, 73, 74, 76, 77, 78, 80, 81, 84, 85, 87, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 1A, 1B, 1C, 1D, 1E, 1F, 1G, 1H, 1I, 1J, 1K, 1L, 1M, 1X, 2A, 2B, 2C, 2I, 2J, 2K, 2L, 2M, 2N, 2P, 2Q, 2R, 2U, 2V, 2W, 2X, 2Y, 2Z, 3B, 3C, 3E, 3G, 3H, 3I, 4A, 4B, 4C, 4E, 4G, 4H, 4K, 4L, 4M, 4N, 4O, 4P, 4Q, 4R, 4T, 4U, 4W, 4X, 5A, 5B, 5C, 5E, 5F, 5G, 5H, 5I, 5J, 5K, 5P, 5Q, A1, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A2, A20, A21, A22, A23, A24, A25, A26, A27, A28, A29, A3, A30, A31, A32, A33, A34, A35, A36, A37, A38, A39, A4, A40, A41, A42, A43, A44, A45, A47, A48, A49, A5, A50, A51, A52, A53, A54, A55, A56, A57, A58, A6, A60, A61, A62, A63, A64, A65, A66, A67, A68, A69, A7, A70, A71, A73, A74, A75, A76, A77, A78, A79, A8, A80, A81, A82, A83, A84, A85, A86, A87, A88, A89, A9, A90, A91, A93, A94, A95, A96, A97, A98, AA, AB, ACR, AD, AE, AH, AI, AJ, AK, AL, AM, AMH, AMP, ANN, AP, APZ, AQ, AR, ARE, AS, ASM, ASU, ATM, ATT, AV, AW, AY, AZ, B0, B1, B11, B12, B13, B14, B15, B16, B18, B2, B20, B21, B22, B23, B24, B25, B26, B27, B28, B29, B3, B31, B32, B33, B34, B35, B36, B37, B38, B39, B4, B40, B41, B42, B43, B44, B45, B46, B47, B48, B49, B5, B50, B51, B52, B53, B54, B55, B56, B57, B58, B59, B6, B60, B61, B62, B63, B64, B65, B66, B67, B69, B7, B70, B71, B72, B73, B74, B75, B76, B77, B78, B79, B8, B81, B83, B84, B85, B86, B87, B88, B89, B9, B90, B91, B92, B93, B94, B95, B96, B97, B98, B99, BAR, BB, BD, BE, BFT, BG, BH, BHP, BIL, BJ, BK, BL, BLD, BLL, BO, BP, BQL, BR, BT, BTU, BUA, BUI, BW, BX, BZ, C0, C1, C10, C11, C12, C13, C14, C15, C16, C17, C18, C19, C2, C20, C22, C23, C24, C25, C26, C27, C28, C29, C3, C30, C31, C32, C33, C34, C35, C36, C38, C39, C4, C40, C41, C42, C43, C44, C45, C46, C47, C48, C49, C5, C50, C51, C52, C53, C54, C55, C56, C57, C58, C59, C6, C60, C61, C62, C63, C64, C65, C66, C67, C68, C69, C7, C70, C71, C72, C73, C75, C76, C77, C78, C8, C80, C81, C82, C83, C84, C85, C86, C87, C88, C89, C9, C90, C91, C92, C93, C94, C95, C96, C97, C98, C99, CA, CCT, CDL, CEL, CEN, CG, CGM, CH, CJ, CK, CKG, CL, CLF, CLT, CMK, CMQ, CMT, CNP, CNT, CO, COU, CQ, CR, CS, CT, CTM, CU, CUR, CV, CWA, CWI, CY, CZ, D1, D10, D12, D13, D14, D15, D16, D17, D18, D19, D2, D20, D21, D22, D23, D24, D25, D26, D27, D28, D29, D30, D31, D32, D33, D34, D35, D37, D38, D39, D40, D41, D42, D43, D44, D45, D46, D47, D48, D49, D5, D50, D51, D52, D53, D54, D55, D56, D57, D58, D59, D6, D60, D61, D62, D63, D64, D65, D66, D67, D69, D7, D70, D71, D72, D73, D74, D75, D76, D77, D79, D8, D80, D81, D82, D83, D85, D86, D87, D88, D89, D9, D90, D91, D92, D93, D94, D95, D96, D97, D98, D99, DAA, DAD, DAY, DB, DC, DD, DE, DEC, DG, DI, DJ, DLT, DMK, DMQ, DMT, DN, DPC, DPR, DPT, DQ, DR, DRA, DRI, DRL, DRM, DS, DT, DTN, DU, DWT, DX, DY, DZN, DZP, E2, E3, E4, E5, EA, EB, EC, EP, EQ, EV, F1, F9, FAH, FAR, FB, FC, FD, FE, FF, FG, FH, FL, FM, FOT, FP, FR, FS, FTK, FTQ, G2, G3, G7, GB, GBQ, GC, GD, GE, GF, GFI, GGR, GH, GIA, GII, GJ, GK, GL, GLD, GLI, GLL, GM, GN, GO, GP, GQ, GRM, GRN, GRO, GRT, GT, GV, GW, GWH, GY, GZ, H1, H2, HA, HAR, HBA, HBX, HC, HD, HE, HF, HGM, HH, HI, HIU, HJ, HK, HL, HLT, HM, HMQ, HMT, HN, HO, HP, HPA, HS, HT, HTZ, HUR, HY, IA, IC, IE, IF, II, IL, IM, INH, INK, INQ, IP, IT, IU, IV, J2, JB, JE, JG, JK, JM, JO, JOU, JR, K1, K2, K3, K5, K6, KA, KB, KBA, KD, KEL, KF, KG, KGM, KGS, KHZ, KI, KJ, KJO, KL, KMH, KMK, KMQ, KNI, KNS, KNT, KO, KPA, KPH, KPO, KPP, KR, KS, KSD, KSH, KT, KTM, KTN, KUR, KVA, KVR, KVT, KW, KWH, KWT, KX, L2, LA, LBR, LBT, LC, LD, LE, LEF, LF, LH, LI, LJ, LK, LM, LN, LO, LP, LPA, LR, LS, LTN, LTR, LUM, LUX, LX, LY, M0, M1, M4, M5, M7, M9, MA, MAL, MAM, MAW, MBE, MBF, MBR, MC, MCU, MD, MF, MGM, MHZ, MIK, MIL, MIN, MIO, MIU, MK, MLD, MLT, MMK, MMQ, MMT, MON, MPA, MQ, MQH, MQS, MSK, MT, MTK, MTQ, MTR, MTS, MV, MVA, MWH, N1, N2, N3, NA, NAR, NB, NBB, NC, NCL, ND, NE, NEW, NF, NG, NH, NI, NIU, NJ, NL, NMI, NMP, NN, NPL, NPR, NPT, NQ, NR, NRL, NT, NTT, NU, NV, NX, NY, OA, OHM, ON, ONZ, OP, OT, OZ, OZA, OZI, P0, P1, P2, P3, P4, P5, P6, P7, P8, P9, PA, PAL, PB, PD, PE, PF, PG, PGL, PI, PK, PL, PM, PN, PO, PQ, PR, PS, PT, PTD, PTI, PTL, PU, PV, PW, PY, PZ, Q3, QA, QAN, QB, QD, QH, QK, QR, QT, QTD, QTI, QTL, QTR, R1, R4, R9, RA, RD, RG, RH, RK, RL, RM, RN, RO, RP, RPM, RPS, RS, RT, RU, S3, S4, S5, S6, S7, S8, SA, SAN, SCO, SCR, SD, SE, SEC, SET, SG, SHT, SIE, SK, SL, SMI, SN, SO, SP, SQ, SR, SS, SST, ST, STI, STN, SV, SW, SX, T0, T1, T3, T4, T5, T6, T7, T8, TA, TAH, TC, TD, TE, TF, TI, TJ, TK, TL, TN, TNE, TP, TPR, TQ, TQD, TR, TRL, TS, TSD, TSH, TT, TU, TV, TW, TY, U1, U2, UA, UB, UC, UD, UE, UF, UH, UM, VA, VI, VLT, VQ, VS, W2, W4, WA, WB, WCD, WE, WEB, WEE, WG, WH, WHR, WI, WM, WR, WSD, WTT, WW, X1, YDK, YDQ, YL, YRD, YT, Z1, Z2, Z3, Z4, Z5, Z6, Z8, ZP, ZZ)

sellersItemIdentification
optional

The ID the seller assigned to this item.
Minimum length : 1

string

standardItemIdentification
optional

Standardized ID for the item.
Minimum length : 1

string

standardItemIdentificationSchemeAgencyId
optional

The scheme agency for the standardized ID for the item.
Default : "9"
Minimum length : 1

string

standardItemIdentificationSchemeId
optional

The scheme for the standardized ID for the item.
Default : "GTIN"
Minimum length : 1

string

tax
optional

The tax for this invoice line.

Tax

amount
required

The amount of VAT. Should equal percentage x amountExcludingVat. A difference of 5 cents or 1% between the calculated value and the provided value is allowed.

number

country
required

Country

percentage
required

The percentage VAT. This should be a valid VAT percentage in the country at the time of the issueDate of this invoice.

number

emails
optional

The email addresses the invoice should be sent to if none of the other identifiers can be used

< string (email) > array

id
optional

DEPRECATED. Use widgetIdentification.id
Minimum length : 2

string

publicIdentifiers
optional

The public identifiers for this invoice recipient. These are the identifiers used on the Peppol network.

PublicIdentifiers

widgetIdentification
optional

The identification for the identifier related to the Storecove Destination Configuration widget.

WidgetIdentification

publicIdentifiers
optional

The public identifiers for this invoice recipient.

PublicIdentifiers

supplierId
optional

DEPRECATED.

integer

widgetIdentification
optional

The identification for the identifier related to the Storecove Destination Configuration widget.

WidgetIdentification

document
optional

The invoice in PDF form. The document should be base64 encoded and the enocded string length should not exceed 2MB (2097152 bytes).
Minimum length : 5

string

documentUrl
optional

A URL to retrieve the PDF document via HTTP GET. If the link expires, please allow at least 7 days of validity.

string (uri)

invoice
required

Invoice

invoiceRecipient
required

InvoiceRecipient

legalEntityId
optional

The id of the LegalEntity this invoice should be sent for.

integer

legalSupplierId
optional

DEPRECATED. Use legalEntityId

integer

mode
optional

DEPRECATED. The mode in which to run this invoice submission.

enum (direct)

supplierId
optional

DEPRECATED.

integer

guid
optional

A (V4) GUID for the invoice submission

string

city
optional

The city.
Length : 2 - 64

string

country
optional

Country

county
optional

County, if applicable
Maximal length : 64

string

id
optional

The Storecove assigned id for the LegalEntity.

integer (int64)

line1
optional

The first address line.
Length : 2 - 64

string

line2
optional

The second address line, if applicable
Maximal length : 64

string

party_name
optional

The name of the company.
Length : 2 - 64

string

peppol_identifiers
optional

< PeppolIdentifier > array

zip
optional

The zipcode.
Length : 2 - 32

string

city
required

The city.
Length : 2 - 64

string

country
required

Country

county
optional

County, if applicable
Maximal length : 64

string

line1
required