Ballerina library

storecove

Module storecove

OverviewPrerequisitesQuickstart

API

Client

Definitions

AccountingCustomerParty
AccountingSupplierParty
AdditionalItemProperty
Address
Administration
AdministrationCreate
AdministrationUpdate
AllowanceCharge
Attachment
ClientHttp1Settings
ConnectionConfig
Contact
Delivery
DeliveryLocation
DiscoverableParticipant
DiscoveredParticipant
DocumentInvoiceResponse
DocumentSubmission
DocumentSubmissionResult
ErrorModel
Invoice
InvoiceData
InvoiceLine
InvoiceRecipient
InvoiceRecipientPreflight
InvoiceResponseClarification
InvoiceSubmission
InvoiceSubmissionActionEvidence
InvoiceSubmissionEvidence
InvoiceSubmissionResult
LegalEntity
LegalEntityCreate
LegalEntityUpdate
Location
Party
PaymentMeans
PaymentMeansDeprecated
PeppolIdentifier
PeppolIdentifierCreate
PreflightInvoiceRecipientResult
ProxyConfig
PublicIdentifier
PurchaseInvoice
PurchaseInvoiceAccountingDetails
PurchaseInvoiceAllowanceCharge
PurchaseInvoiceAttachment
PurchaseinvoiceDelivery
PurchaseInvoiceInvoiceLine
PurchaseInvoiceInvoiceLineAllowanceCharge
PurchaseinvoiceParty
PurchaseInvoicePaymentMeans
PurchaseInvoiceSender
PurchaseInvoiceSenderBillingContact
PurchaseInvoiceTax
PurchaseInvoiceTaxElement
PurchaseInvoiceTaxSubtotal
PurchaseInvoiceUbl
PurchaseInvoiceVat
RawDocumentData
Routing
RoutingIdentifier
SendableDocument
SupplierParty
Tax
TaxSubtotal
ThePaymentTerms
VatDetails
WebhookInstance

Country
CurrencyCode

ballerinax/storecove Ballerina library

1.5.1

Overview

This is a generated connector for Storecove API v2 OpenAPI specification.

Storecove API provides the capability to perform e-invoice management operations.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Quickstart

To use the Storecove connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

First, import the ballerinax/storecove module into the Ballerina project.

Copy
import ballerinax/storecove;

Step 2: Create a new connector instance

Create client using connection configuration. Create a storecove:ClientConfig with the OAuth2 tokens obtained, and initialize the connector with it.

Copy
storecove:ClientConfig configuration = {
    auth: {
        token : "<API_KEY>"
    }
};

storecove:Client storecoveClient = check new (configuration);

Step 3: Invoke connector operation

  1. Now you can use the operations available within the connector. Note that they are in the form of remote operations.
    Following is an example on how to get legal entity using the connector. 
    Copy
    public function main() returns error? {
    storecove:LegalEntity entity = check storecoveClient->getLegalEntity(123);
}
  2. Use bal run command to compile and run the Ballerina program.

Clients

storecove: Client

Isolated

This is a generated connector for Storcove API v2 OpenAPI Specification. Storecove API provides the capability to do e-invoice management operations.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create Storcove account and obtain tokens by following this guide.

init (ConnectionConfig config, string serviceUrl)
  • config ConnectionConfig - The configurations to be used when initializing the connector
  • serviceUrl string "https://api.storecove.com/api/v2" - URL of the target service

discoveryReceives

Isolated FunctionRemote Function
function discoveryReceives(DiscoverableParticipant payload) returns DiscoveredParticipant|error

Discover Network Participant

Parameters
Return Type

createDocumentSubmission

Isolated FunctionRemote Function
function createDocumentSubmission(DocumentSubmission payload) returns DocumentSubmissionResult|error

*** NOTE: Experimental. Only to be used for sending Invoice Response documents. *** Submit a new document.

Parameters
Return Type

createInvoiceSubmission

Isolated FunctionRemote Function
function createInvoiceSubmission(InvoiceSubmission payload) returns InvoiceSubmissionResult|error

Submit a new invoice

Parameters
Return Type

preflightInvoiceRecipient

Isolated FunctionRemote Function
function preflightInvoiceRecipient(InvoiceRecipientPreflight payload) returns PreflightInvoiceRecipientResult|error

Preflight an invoice recipient

Parameters
Return Type

showInvoiceSubmissionEvidence

Isolated FunctionRemote Function
function showInvoiceSubmissionEvidence(string guid) returns InvoiceSubmissionEvidence|error

Get InvoiceSubmission Evidence

Parameters
  • guid string - InvoiceSubmission GUID
Return Type

createLegalEntity

Isolated FunctionRemote Function
function createLegalEntity(LegalEntityCreate payload) returns LegalEntity|error

Create a new LegalEntity

Parameters
Return Type

getLegalEntity

Isolated FunctionRemote Function
function getLegalEntity(int id) returns LegalEntity|error

Get LegalEntity

Parameters
  • id int - legal_entity id
Return Type

deleteLegalEntity

Isolated FunctionRemote Function
function deleteLegalEntity(int id) returns Response|error

Delete LegalEntity

Parameters
  • id int - legal_entity id
Return Type

updateLegalEntity

Isolated FunctionRemote Function
function updateLegalEntity(int id, LegalEntityUpdate payload) returns LegalEntity|error

Update LegalEntity

Parameters
  • id int - legal_entity id
Return Type

createAdministration

Isolated FunctionRemote Function
function createAdministration(int legalEntityId, AdministrationCreate payload) returns Administration|error

Create a new Administration

Parameters
  • legalEntityId int - The id of the LegalEntity for which to create the Administration
Return Type

getAdministration

Isolated FunctionRemote Function
function getAdministration(int legalEntityId, int id) returns Administration|error

Get Administration

Parameters
  • legalEntityId int - The id of the LegalEntity the Administration belongs to
  • id int - The id of the Administration
Return Type

deleteAdministration

Isolated FunctionRemote Function
function deleteAdministration(int legalEntityId, int id) returns Response|error

Delete Administration

Parameters
  • legalEntityId int - The id of the LegalEntity the Administration belongs to
  • id int - The id of the Administration
Return Type

updateAdministration

Isolated FunctionRemote Function
function updateAdministration(int legalEntityId, int id, AdministrationUpdate payload) returns Administration|error

Update Administration

Parameters
  • legalEntityId int - The id of the LegalEntity the Administration belongs to
  • id int - The id of the Administration to be updated
Return Type

createPeppolIdentifier

Isolated FunctionRemote Function
function createPeppolIdentifier(int legalEntityId, PeppolIdentifierCreate payload) returns PeppolIdentifier|error

Create a new PeppolIdentifier

Parameters
  • legalEntityId int - The id of the LegalEntity for which to create the PeppolIdentifier
Return Type

deletePeppolIdentifier

Isolated FunctionRemote Function
function deletePeppolIdentifier(int legalEntityId, string superscheme, string scheme, string identifier) returns Response|error

Delete PeppolIdentifier

Parameters
  • legalEntityId int - The id of the LegalEntity this PeppolIdentifier belongs to
  • superscheme string - The superscheme of the identifier. Should always be "iso6523-actorid-upis".
  • scheme string - PEPPOL identifier scheme id, e.g. "DE:VAT". For a full list see <<_peppol_participant_identifier_list>>.
  • identifier string - PEPPOL identifier
Return Type

getInvoiceJson

Isolated FunctionRemote Function
function getInvoiceJson(string guid, string pmv) returns PurchaseInvoice|error

Get Purchase invoice data as JSON

Parameters
  • guid string - The guid of the purchase invoice, from the webhook.
  • pmv string (default "1.0") - 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.
Return Type

getInvoiceUbl

Isolated FunctionRemote Function
function getInvoiceUbl(string guid, string packaging) returns PurchaseInvoiceUbl|error

Get Purchase invoice data as JSON with a Base64-encoded SI-1.2 UBL string

Parameters
  • guid string - purchase invoice guid
  • packaging string - How to package the purchase invoice. Use "json" or "ubl"
Return Type

getInvoiceUblVersioned

Isolated FunctionRemote Function
function getInvoiceUblVersioned(string guid, string packaging, string packageVersion) returns PurchaseInvoiceUbl|error

Get Purchase invoice data as JSON with a Base64-encoded UBL string in the specified version

Parameters
  • guid string - purchase invoice guid
  • packaging string - How to package the purchase invoice. Use "ubl"
  • packageVersion string - The version of the ubl package.
Return Type

getWebhookInstances

Isolated FunctionRemote Function
function getWebhookInstances() returns WebhookInstance|error?

Get a WebhookInstance

Return Type

deleteWebhookInstance

Isolated FunctionRemote Function
function deleteWebhookInstance(string guid) returns Response|error

Delete a WebhookInstance

Parameters
  • guid string - WebhookInstance guid
Return Type

Records

storecove: AccountingCustomerParty

The customer receiving the invoice.

Fields
  • accountId string? - The account id you assigned to the customer.
  • party Party - A party that can receive or send invoices
  • publicIdentifiers PublicIdentifier[]? - A list of legal and tax identifiers for this customer.

storecove: AccountingSupplierParty

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 here that you can specify on an invoice-by-invoice basis.

Fields

storecove: AdditionalItemProperty

An additional property for the item

Fields
  • name string - The name of the property.
  • value string - The value of the property.

storecove: Address

The address

Fields
  • city string? - The name of the city. Mandatory in most countries.
  • country Country - An ISO 3166-1 alpha-2 country code.
  • county string? - An optional county name.
  • street1 string? - The street name and number. Mandatory in most countries.
  • street2 string? - The second street field. Use this if you used the first field for the building name.
  • zip string? - The zipcode/postalzone. Mandatory unless the country does not have zip codes.

storecove: Administration

Fields
  • email string? - The email address to send the received document to
  • id int? - The Storecove assigned id for the Administration.
  • package_version string? - The version of the package.
  • packaging string? - How to package the purchase invoice.
  • sender_email_identity_id int? - The id of the SenderEmailIdentity. If not provided, the Storecove default sender will be used

storecove: AdministrationCreate

Fields
  • email string? - The email address to send the received document to
  • package_version string? - The version of the package.
  • packaging string? - How to package the purchase invoice.
  • sender_email_identity_id int? - The id of the SenderEmailIdentity. If not provided, the Storecove default sender will be used

storecove: AdministrationUpdate

Fields
  • email string? - The email address to send the received document to
  • package_version string? - The version of the package.
  • packaging string? - How to package the purchase invoice.
  • sender_email_identity_id int? - The id of the SenderEmailIdentity. If not provided, the Storecove default sender will be used

storecove: AllowanceCharge

Fields
  • amountExcludingVat decimal - The amount for the allowance or charge, excluding VAT
  • reason string(default "Agreed settlement") - The reason for the allowance or charge, free text
  • reasonCode string? - Do not use. Contact Storecove first if you want to use this field.
  • taxes_duties_fees Tax[]? - An array of taxes, duties and fees for this allowance or charge. At this moment, only a single Tax item is allowed. When used, the 'tax' element must be empty.

storecove: Attachment

A document attachment to the invoice.

Fields
  • document string - The base64 encoded version of the document attachment.
  • filename string? - The name of the file attachment.
  • mimeType string - The document attachment mime type. Currently only application/pdf is allowed.
  • primaryImage boolean(default false) - Whether or not this document is a visual representation of the invoice data.

storecove: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields
  • keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
  • chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

storecove: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields
  • httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
  • timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
  • forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header
  • cache CacheConfig? - HTTP caching related configurations
  • compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header
  • circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
  • retryConfig RetryConfig? - Configurations associated with retrying
  • validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

storecove: Contact

Contact details for the invoice

Fields
  • firstName string? - First name
  • id string? - Only supported for AccountingCustomerParty

storecove: Delivery

Delivery details.

Fields
  • actualDate string? - The actual date of the delivery.
  • quantity decimal? - The quantity of the delivery.

storecove: DeliveryLocation

Location

Fields
  • id string? - The location identifier.
  • schemeAgencyId string? - The schemeAgencyId of the location identifier (e.g. 'ZZZ')
  • schemeId string? - The schemeId of the location identifier (e.g. 'EAN')

storecove: DiscoverableParticipant

A participant to be discovered.

Fields
  • documentTypes string[]? - An array of document types to discover. The default is '["invoice", "creditnote"]'
  • identifier string - The actual identifier.
  • metaScheme string(default "iso6523-actorid-upis") - The meta scheme of the identifier. For Peppol this is always 'iso6523-actorid-upis'.
  • network string(default "peppol") - The network to check. Currently only 'peppol' is supported.
  • scheme string - The scheme of the identifier. See <<_peppol_participant_identifier_list>> for a list.

storecove: DiscoveredParticipant

A public identifier for this customer.

Fields
  • code string? - The response code.
  • email boolean? - Whether or not an 'OK' response means the document will be sent via Peppol, but delivered by email. This happens in the Belgian Hermes system where all identifiers have been registered, but if the receiver hasn't registered with a service provider, the Hermes system will send a PDF created from the electronic invoice and email that. The electronic document will itself not be emailed. Also see https://einvoice.belgium.be/en/article/send-structured-invoices-all-your-customers-hermes[Hermes^].

storecove: DocumentInvoiceResponse

The invoice response to send.

Fields
  • clarifications InvoiceResponseClarification[]? - A list of clarifications why a received invoice was rejected (RE) or under query (UQ) and what action to take.
  • effectiveDate string? - The date when the status became effective. Format: yyyy-mm-dd.
  • note string? - A note to add to the invoice reponse
  • responseCode string - The response code. For details see https://docs.peppol.eu/poacc/upgrade-3/codelist/UNCL4343-T111/

storecove: DocumentSubmission

The document you want Storecove to send, with some meta-data.

Fields
  • attachments Attachment[]? - An array of attachments. You may provide up to 10 attchments, but the total size must not exceed 10MB after Base64 encoding.
  • createPrimaryImage boolean? - Whether or not to create a primary image (PDF) if one is not provided.
  • idempotencyGuid string? - A guid that you generated for this DocumentSubmission to achieve idempotency. If you submit multiple documents with the same idempotencyGuid, only the first one will be processed and any subsequent ones will trigger an HTTP 422 Unprocessable Entity response.
  • legalEntityId int? - The id of the LegalEntity this document should be sent on behalf of. Either legalEntityId or receiveGuid is mandatory.
  • receiveGuid string? - The GUID that was in the received_invoice webhook. Either legalEntityId or receiveGuid is mandatory.
  • routing Routing? - The different ways to send the invoice to the recipient. The publicIdentifiers are used to send via the Peppol network, if the recipient is not registered on the Peppol network, the invoice will be sent to the email addresses in the emails property. This property is only mandatory when sending the invoice data using the <<_openapi_invoice>> property, not when sending using the <<_openapi_invoicedata>> property, in which case this information will be extracted from the <<_openapi_invoicedata>> object. If you do specify an <<_openapi_invoicerecipient>> object and an <<_openapi_invoicedata>> object, the data from the two will be merged.

storecove: DocumentSubmissionResult

The result of a document submission

Fields
  • guid string? - A (V4) GUID for the document submission

storecove: ErrorModel

Fields

storecove: Invoice

The invoice to send. Provide either invoice, or invoiceData, but not both.

Fields
  • accountingCost string? - The buyer's accounting cost centre for this invoice, expressed as text.
  • accountingSupplierParty AccountingSupplierParty? - 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 here that you can specify on an invoice-by-invoice basis.
  • amountIncludingVat decimal - 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.
  • billingReference string? - 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.
  • buyerReference string? - A reference provided by the buyer used for internal routing of the document.
  • consumerTaxMode boolean(default false) - Whether or not to process the invoice in consumer tax mode. In this mode, the VAT identifier of the sender will not be the default VAT identifier, but the one that matches with the country of the receiving consumer, if that additional VAT identifier for that country is available. These additional VAT identifiers need to be added to the sending LegalEntity by Storecove, so if you need to send invoices in this mode, please contact us.
  • contractDocumentReference string? - A reference to a contract or framework agreement that this invoice relates to.
  • documentCurrencyCode CurrencyCode? - The ISO 4217 currency code.
  • dueDate string? - Format: yyyy-mm-dd.
  • invoiceLines InvoiceLine[] - An array of invoice lines.
  • invoiceNumber string - 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.
  • invoicePeriod string? - The period (or specific date) to which the invoice applies. Format: yyyy-mm-dd - yyyy-mm-dd.
  • invoiceType string(default "380") - Do not use. This field is available for legacy reasons only. If you want to send a regular invoice (aka UBL type '380'), make sure you have a positive invoice amount. For a credit note (aka UBL type '381'), simply provide a negative invoice amount. If you, in addition to a negative invoice amount, also specify a billingReferences, your invoice will become a corrective invoice (aka UBL type '384'). If your invoice is not sent in the UBL syntax, Storecove will provide the appropriate type for the syntax the invoice is sent in.
  • issueDate string - Format: yyyy-mm-dd.
  • note string? - A note to add to the invoice
  • orderReference string? - A reference to an order for this invoice, assigned by the buyer. Note that this often is a key field, since many receivers of invoices will use this field to automatically match the invoice to an order they placed. Many receivers refuse invoices that cannot be automatically matched, in particular government agencies. So it is highly recommended to fill this field whenever possible.
  • paymentMeansArray PaymentMeans[]? - An array of payment means (ways to pay the invoice).
  • paymentMeansBic string? - DEPRECATED. Use paymentMeansArray. The BIC (Swift) of the bank where the amount payable should be transferred to
  • paymentMeansCode string? - DEPRECATED. Use paymentMeansArray. How the invoice has been / will be paid. Use only online_payment_service (payment will be made or has been made by an online payment service), bank_card (e.g. debit card, credit card), direct_debit (the amount has been / will be taken out of the client's bank account), standing_agreement (an unspecified payment means known to both buyer and seller) or credit_transfer (the buyer will do / has done a bank transfer). The numeric codes are for legacy purposes, they should not be used.
  • paymentMeansIban string? - DEPRECATED. Use paymentMeansArray. The IBAN the amount payable should be transferred to
  • paymentMeansPaymentId string? - DEPRECATED. Use the paymentId in the individual PaymentMeans object. The payment id that you will use to match the payment against the invoice.
  • prepaidAmount decimal? - The amount already paid.
  • projectReference string? - Information about the project this invoice relates to.
  • salesOrderId string? - A reference to an order for this invoice, assigned by the seller.
  • taxExemptReason string? - DEPRECATED. Use Tax/category and specify this per invoice line. If you do specify this field, it will be applied to all invoice lines and it is an error to specify a Tax/category at the invoice line level. This field holds the reason no tax is present in the invoice. Note that this is an invoice level field and you cannot specify it per invoice line. This field is mandatory unless tax is present in the invoice.
  • taxPointDate string? - 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.
  • taxSubtotals TaxSubtotal[]? - An array of tax subtotals. This element is mandatory for taxSystem 'tax_line_percentages'.
  • taxSystem string(default "tax_line_amounts") - The tax system used for the invoice. The system 'tax_line_percentages' is preferred, but for historic purposes 'tax_line_amounts is supported and default. Since not all invoice formats that we are required to send support 'tax_line_amounts' we will need to convert the invoice to the 'tax_line_percentags' system if we are forced to send the invoice in that tax system.
  • ublExtensions string[]? - An array of ubl extensions.
  • vatReverseCharge boolean(default false) - DEPRECTATED. Use taxExemptReason.

storecove: InvoiceData

The invoice to send, in base64 encoded format. Provide either invoice, or invoiceData, but not both.

Fields
  • conversionStrategy string? - How to interpret the document.
  • document string? - The base64 encoded version of the document.

storecove: InvoiceLine

Represents invoice line.

Fields
  • accountingCost string? - The buyer's accounting cost centre for this invoice line, expressed as text.
  • allowanceCharge decimal? - The discount or surcharge on this item. Should be negative for discounts
  • amountExcludingVat decimal - The amount excluding VAT. Should equal quantity x itemPrice + allowanceCharge.
  • buyersItemIdentification string? - The ID the buyer assigned to this item.
  • description string? - The description for this invoice line.
  • invoicePeriod string? - The period (or specific date) to which the invoice line applies. Format: yyyy-mm-dd - yyyy-mm-dd.
  • itemPrice decimal(default 1) - The price per item (may be fractional)
  • lineId string? - The id for this invoice line.
  • name string? - 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.
  • orderLineReferenceLineId string? - A reference to the ID of the order. The order is specified as the orderReference at the invoice level. It is not possible to specify an orderReference at the invoice line level. An invoice MUST at this time be for a single order only.
  • quantity decimal(default 1) - The number of items (may be fractional).
  • quantityUnitCode string(default "C62") - The unit of measure that applies to the invoiced quantity. Codes for unit of packaging from UNECE Recommendation No. 21 can be used in accordance with the descriptions in the "Intro" section of UN/ECE Recommendation 20, Revision 11 (2015): The 2 character alphanumeric code values in UNECE Recommendation 21 shall be used. To avoid duplication with existing code values in UNECE Recommendation No. 20, each code value from UNECE Recommendation 21 shall be prefixed with an “X”, resulting in a 3 alphanumeric code when used as a unit of measure. Note that the following additionally allowed codes are deprecated and will be converted to C62: 04, 05, 08, 16, 17, 18, 19, 26, 29, 30, 31, 32, 36, 43, 44, 45, 46, 47, 48, 53, 54, 62, 63, 64, 66, 69, 71, 72, 73, 76, 78, 84, 90, 92, 93, 94, 95, 96, 97, 98, 1A, 1B, 1C, 1D, 1E, 1F, 1G, 1H, 1J, 1K, 1L, 1M, 1X, 2V, 2W, 3E, 3G, 3H, 3I, 4A, 4B, 4E, 5C, 5F, 5G, 5H, 5I, 5K, 5P, 5Q, A1, A25, A50, A51, A52, A57, A58, A60, A61, A62, A63, A64, A65, A66, A67, A77, A78, A79, A80, A81, A82, A83, AJ, AM, AP, AR, ARE, ATT, AV, AW, B0, B2, B36, B37, B38, B39, B40, B5, B51, B6, B65, B9, BD, BE, BG, BH, BJ, BK, BL, BO, BR, BT, BW, BX, BZ, C1, C2, C4, C5, C6, C77, C98, CA, CH, CJ, CK, CL, CO, CQ, CR, CS, CT, CU, CV, CY, CZ, D14, D28, D35, D37, D38, D39, D40, D64, D66, D67, D7, D70, D71, D72, D75, D76, D79, D8, D9, D90, D92, D96, D97, D98, D99, DC, DE, DI, DQ, DR, DRM, DS, DU, DX, DY, E2, E3, E5, EC, EP, EV, F1, F9, FB, FD, FE, FG, FM, G7, GC, GD, GH, GK, GN, GRT, GT, GW, GY, GZ, H1, H2, HAR, HD, HE, HF, HI, HJ, HK, HL, HN, HO, HP, HS, HT, HY, IC, IF, II, IL, IM, IP, IT, JB, JG, JO, JR, K5, KD, KF, KG, KS, KTM, LC, LE, LI, LJ, LX, M0, MA, MF, MK, MQ, MT, MV, N2, NB, NBB, NC, ND, NE, NG, NH, NI, NJ, NN, NPL, NPR, NQ, NR, NRL, NTT, NV, NY, OP, OZ, P0, P3, P4, P6, P7, P8, P9, PA, PB, PE, PF, PG, PK, PL, PM, PN, PT, PU, PV, PW, PY, PZ, QD, QH, QK, QT, R4, RA, RD, RG, RK, RL, RN, RO, RS, RU, S5, S6, S7, S8, SA, SD, SE, SHT, SK, SL, SN, SO, SP, SS, SST, ST, SV, T1, T4, T5, T6, T7, T8, TA, TC, TD, TE, TF, TJ, TK, TL, TN, TQ, TR, TS, TSD, TSH, TT, TU, TV, TW, TY, UA, UD, UE, UF, UH, UM, VI, VQ, VS, W4, WH, WI, WR, WW, YL, YT, Z1, Z2, Z3, Z4, Z5, Z6, Z8
  • sellersItemIdentification string? - The ID the seller assigned to this item.
  • standardItemIdentification string? - Standardized ID for the item.
  • standardItemIdentificationSchemeAgencyId string(default "9") - The scheme agency for the standardized ID for the item.
  • standardItemIdentificationSchemeId string(default "GTIN") - The scheme for the standardized ID for the item.
  • taxes_duties_fees Tax[]? - An array of taxes, duties and fees for this invoice line. At this moment, only a single Tax item is allowed. When used, the 'tax' element must be empty.

storecove: InvoiceRecipient

The different ways to send the invoice to the recipient. The publicIdentifiers are used to send via the Peppol network, if the recipient is not registered on the Peppol network, the invoice will be sent to the email addresses in the emails property. This property is only mandatory when sending the invoice data using the <<_openapi_invoice>> property, not when sending using the <<_openapi_invoicedata>> property, in which case this information will be extracted from the <<_openapi_invoicedata>> object. If you do specify an <<_openapi_invoicerecipient>> object and an <<_openapi_invoicedata>> object, the data from the two will be merged.

Fields
  • emails string[]? - The email addresses the invoice should be sent to if none of the other identifiers can be used
  • publicIdentifiers PublicIdentifiers? - A list of public identifiers that uniquely identify this customer.

storecove: InvoiceRecipientPreflight

Identifies the invoice recipient to preflight

Fields
  • publicIdentifiers PublicIdentifiers? - A list of public identifiers that uniquely identify this customer.

storecove: InvoiceResponseClarification

A clarification for why a received invoice was rejected (RE) or under query (UQ) and what action to take.

Fields
  • clarification string? - A textual description of the clarification
  • clarificationCode string - The code for the clarification. For details see https://docs.peppol.eu/poacc/upgrade-3/codelist/OPStatusReason/ and https://docs.peppol.eu/poacc/upgrade-3/codelist/OPStatusAction/
  • clarificationCodeType string - The type of the clarification.

storecove: InvoiceSubmission

The invoice you want Storecove to process, with some meta-data.

Fields
  • attachments Attachment[]? - An array of attachments. You may provide up to 10 attchments, but the total size must not exceed 10MB after Base64 encoding.
  • createPrimaryImage boolean? - Whether or not to create a primary image (PDF) if one is not provided.
  • document string? - DEPRECATED. Use attachments.
  • documentUrl string? - DEPRECATED. Use attachments.
  • idempotencyGuid string? - A guid that you generated for this InvoiceSubmission to achieve idempotency. If you submit multiple documents with the same idempotencyGuid, only the first one will be processed.
  • invoice Invoice? - The invoice to send. Provide either invoice, or invoiceData, but not both.
  • invoiceData InvoiceData? - The invoice to send, in base64 encoded format. Provide either invoice, or invoiceData, but not both.
  • invoiceRecipient InvoiceRecipient? - The different ways to send the invoice to the recipient. The publicIdentifiers are used to send via the Peppol network, if the recipient is not registered on the Peppol network, the invoice will be sent to the email addresses in the emails property. This property is only mandatory when sending the invoice data using the <<_openapi_invoice>> property, not when sending using the <<_openapi_invoicedata>> property, in which case this information will be extracted from the <<_openapi_invoicedata>> object. If you do specify an <<_openapi_invoicerecipient>> object and an <<_openapi_invoicedata>> object, the data from the two will be merged.
  • legalEntityId int? - The id of the LegalEntity this invoice should be sent for.
  • legalSupplierId int? - DEPRECATED. Use legalEntityId
  • routing Routing? - The different ways to send the invoice to the recipient. The publicIdentifiers are used to send via the Peppol network, if the recipient is not registered on the Peppol network, the invoice will be sent to the email addresses in the emails property. This property is only mandatory when sending the invoice data using the <<_openapi_invoice>> property, not when sending using the <<_openapi_invoicedata>> property, in which case this information will be extracted from the <<_openapi_invoicedata>> object. If you do specify an <<_openapi_invoicerecipient>> object and an <<_openapi_invoicedata>> object, the data from the two will be merged.
  • supplierId int? - DEPRECATED.

storecove: InvoiceSubmissionActionEvidence

Fields
  • receiver_response string? - The response the receiver sent.
  • transmission_datetime string? - The DateTime of the transmission, as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z.
  • transmission_result string? - The result of this transmission.
  • transmission_type string? - How the document was transmitted.
  • transmitted_document string? - The document that was transmitted.

storecove: InvoiceSubmissionEvidence

Fields
  • guid string? - The guid for the InvoiceSubmission.
  • status string? - The overall status for this InvoiceSubmission.

storecove: InvoiceSubmissionResult

The result of an invoice submission

Fields
  • guid string? - A (V4) GUID for the invoice submission

storecove: LegalEntity

Fields

storecove: LegalEntityCreate

Fields
  • advertisements string[](default ["invoice"]) - A list of document types to advertise. Use if this LegalEntity needs the ability to receive more than only invoice documents.
  • country Country - An ISO 3166-1 alpha-2 country code.
  • county string? - County, if applicable
  • line1 string - The first address line.
  • line2 string? - The second address line, if applicable
  • party_name string - The name of the company.
  • 'public boolean(default true) - Whether or not this LegalEntity is public. Public means it will be entered into the PEPPOL directory at https://directory.peppol.eu/
  • tenant_id string? - The id of the tenant, to be used in case of multi-tenant solutions. This property will included in webhook events.

storecove: LegalEntityUpdate

Fields
  • advertisements string[]? - A list of document types to advertise. Use if this LegalEntity needs the ability to receive more than only invoice documents.
  • country Country? - An ISO 3166-1 alpha-2 country code.
  • county string? - County, if applicable
  • id int? - The Storecove assigned id for the LegalEntity.
  • line1 string? - The first address line.
  • line2 string? - The second address line, if applicable
  • party_name string? - The name of the company.
  • 'public boolean? - Whether or not this LegalEntity is public. Public means it will be listed in the PEPPOL directory at https://directory.peppol.eu/ which is normally what you want. If you have a good reason to not want the LegalEntity listed, provide false. This property is ignored when for country SG, where it is always true.
  • tenant_id string? - The id of the tenant, to be used in case of multi-tenant solutions. This property will included in webhook events.

storecove: Location

The location the goods/services were delivered to.

Fields
  • country string? - Address country.
  • county string? - Address county.
  • department string? - Department name.
  • id string? - The id of the location.
  • line1 string? - Address line 1.
  • line2 string? - Address line 2.
  • scheme_id string? - The scheme id for the id of the location.
  • zip string? - Address zip code

storecove: Party

A party that can receive or send invoices

Fields
  • companyName string - The name of the company receiving the invoice
  • contact Contact? - Contact details for the invoice

storecove: PaymentMeans

A PaymentMeans is a way to pay the invoice.

Fields
  • account string? - The account number.
  • branche_code string? - The bank branch code. Not required for IBAN numbers. Often referred to as Swift or Bic code.
  • code string - How the invoice has been / will be paid. The code determines which type of PaymentMeans is used and which fields are mandatory.
  • holder string? - The name of the account holder.
  • mandate string? - The direct debit mandate code.
  • network string? - The name of the card network, e.g. VISA.
  • paymentId string? - The payment id that you will use to match the payment against the invoice.

storecove: PaymentMeansDeprecated

DEPRECATED - Use the new payment_means_array array.

Fields
  • iban string? - The IBAN to which to transfer.
  • id string? - An id to mention in the transfer.

storecove: PeppolIdentifier

Fields
  • identifier string? - The identifier.
  • scheme string? - The scheme of the identifier. See <<_peppol_participant_identifier_list>> for a list.
  • superscheme string? - The superscheme of the identifier. Should always be "iso6523-actorid-upis".

storecove: PeppolIdentifierCreate

Fields
  • identifier string - The identifier.
  • scheme string - The scheme of the identifier. See <<_peppol_participant_identifier_list>> for a list.
  • superscheme string - The superscheme of the identifier. Should always be "iso6523-actorid-upis".

storecove: PreflightInvoiceRecipientResult

The result of preflighting an invoice recipient

Fields
  • code string? - The result code of the preflight request

storecove: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields
  • host string(default "") - Host name of the proxy server
  • port int(default 0) - Proxy server port
  • userName string(default "") - Proxy server username
  • password string(default "") - Proxy server password

storecove: PublicIdentifier

A public identifier for this customer.

Fields
  • id string - The actual identifier.
  • scheme string - The scheme of the identifier. See <<_peppol_participant_identifier_list>> for a list.

storecove: PurchaseInvoice

Fields
  • accounting_cost string? - The accounting cost code.
  • allowance_charge decimal? - DEPRECATED - Use the allowance_charges array.
  • amount_including_tax decimal? - The total invoice amount payable, including tax. This is equal to the sum of the invoice_lines (amount_excluding_tax + tax.amount)
  • amount_including_vat decimal? - DEPRECATED - Use amount_including_tax.
  • billing_reference string? - Reference to the previous invoice this invoice relates to.
  • buyer_reference string? - Reference provided by the buyer. Used for routing.
  • contract_document_reference string? - Reference to the contract.
  • document string? - DEPRECTATED. Use the new atatchments array.
  • document_currency_code string? - The ISO 4217 currency for the invoice.
  • due_date string? - The date the invoice must be payed by. Format "YYYY-MM-DD".
  • external_key string? - Used for accountants. The id you specified for the organization.
  • external_user_id string? - Used for the embedded portal retrieval service. The external_user_id you provided when the ShopAccount was created.
  • guid string? - The GUID of the invoice
  • invoice_number string? - The invoicenumber.
  • invoice_type string? - The type of invoice.
  • issue_date string? - The date the invoice was issued. Format "YYYY-MM-DD".
  • note string? - The invoice level note.
  • order_reference string? - Reference to the order. Used for matching the invoice to an order.
  • payable_amount decimal? - The total invoice amount payable including tax. This is equal to amount_including_tax + allowance_charge + payable_rounding_amount. This property is redundant and provided only to make invoice processing easier. You can also choose to only store this property, instead of the underlying fields.
  • payable_rounding_amount decimal? - The difference between the invoice total and the sum of the invoice lines.
  • payment_means_payment_id string? - DEPRECATED - use the payment_id property in the payment_means_array
  • payment_terms_note string? - A textual description of the payment terms.
  • period_end string? - The end date of the period this invoice relates to. Format "YYYY-MM-DD".
  • period_start string? - The start date of the period this invoice relates to. Format "YYYY-MM-DD".
  • prepaid_amount decimal? - The amount already paid.
  • project_reference string? - Reference to the project.
  • 'source string? - The source the invoice was received from.
  • system_generated_primary_image boolean? - 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..
  • tax_point_date string? - The date the invoice was issued for tax purposes. In most countries MUST match the issue_date. Format "YYYY-MM-DD".
  • tax_system string? - 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.
  • vat_reverse_charge boolean? - DEPRECATED - This is now part of each invoice line.

storecove: PurchaseInvoiceAccountingDetails

Fields
  • code string? - The the code of the general ledger account.
  • list string? - The name of the list for the code, e.g. "RGS".
  • list_version string? - The version of the list for the code, e.g. "1.1".
  • name string? - A textual description of the code.

storecove: PurchaseInvoiceAllowanceCharge

Fields
  • amount_excluding_tax decimal? - The amount excluding tax.
  • amount_excluding_vat string? - DEPRECATED - use amount_excluding_tax.
  • reason string? - The reason for the allowance or charge.

storecove: PurchaseInvoiceAttachment

Fields
  • content_type string? - The attachment content type (mime type).
  • document string? - The Base64 encoded document attachment.

storecove: PurchaseinvoiceDelivery

The details of the delivery associated with this invoice.

Fields
  • actual_date string? - The actual delivery date.
  • location Location? - The location the goods/services were delivered to.

storecove: PurchaseInvoiceInvoiceLine

Fields
  • allowance_charge decimal? - DEPRECATED - use allowance_charges.
  • amount_excluding_tax decimal? - The amount excluding Tax. This is equal to quantity x price_amount + ∑ allowance_charges.
  • amount_excluding_vat decimal? - DEPRECTATED - use amount_excluding_tax The amount excluding VAT.
  • description string? - The description for the invoice line.
  • price_amount decimal? - The price for one item, excluding VAT.
  • quantity decimal? - The quantity of the item.
  • vat VatDetails? - The VAT details for the invoice line.

storecove: PurchaseInvoiceInvoiceLineAllowanceCharge

Fields
  • amount decimal? - The amount of the allowance or charge.

storecove: PurchaseinvoiceParty

The party the goods/services were delivered to.

Fields
  • name string? - The name of the deliveyr party.

storecove: PurchaseInvoicePaymentMeans

Fields
  • account string? - The account number to which to transfer.
  • branch_code string? - The code identifying the bank branch. May contain a BIC/SWIFT or something appropriate for the payment method, such as "NPP" for type NppPaymentMean.
  • holder string? - The account holder name to which to transfer.
  • mandate string? - The mandate, used only for type DirectDebitPaymentMean.
  • network string? - The payment network. Used only for type CardPaymentType.
  • payment_id string? - The payment id to use when making the payment. The invoice sender will use this to match the received funds to the invoice.
  • 'type string? - The type of payment means. Which type are returned is determined by the &pmv= query parameter. For details see documentation for that field.

storecove: PurchaseInvoiceSender

Fields
  • country string? - The country.
  • department string? - The department who sent the invoice.
  • line2 string? - The address, line 2
  • party_name string? - The party who sent the invoice.

storecove: PurchaseInvoiceSenderBillingContact

Fields
  • email string? - The email of the billing contact.
  • first_name string? - The first name of the billing contact.
  • last_name string? - The last name of the billing contact.

storecove: PurchaseInvoiceTax

Fields

storecove: PurchaseInvoiceTaxElement

The tax element.

Fields
  • amount string? - The tax country.
  • category string? - The tax category.
  • category_code string? - The tax category code.
  • percentage decimal? - The tax percentage.

storecove: PurchaseInvoiceTaxSubtotal

Fields
  • amount_excluding_tax decimal? - The amount excluding tax.
  • amount_excluding_vat string? - DEPRECATED - use amount_excluding_tax.

storecove: PurchaseInvoiceUbl

Fields
  • external_key string? - Used for accountants. The id you specified for the organization.
  • external_user_id string? - Used for the embedded portal retrieval service. The external_user_id you provided when the ShopAccount was created.
  • guid string? - The GUID of the invoice
  • system_generated_primary_image boolean? - 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.
  • tax_system string? - 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.
  • ubl string? - The Base64 encoded UBL invoice.

storecove: PurchaseInvoiceVat

DEPRECATED - Use tax.

Fields
  • amount string? - The VAT country.
  • percentage string? - The VAT percentage.

storecove: RawDocumentData

A document to send, in base64 encoded format.

Fields
  • document string - The base64 encoded version of the document.
  • documentTypeId string? - The document type id of the document. Required when parse == false.
  • parse boolean(default true) - *** NOTE: only parse == true is currently supported *** *** NOTE: parsing is only supported for documentType == 'invoice' *** Whether or not to parse the document. If true, the data will be extracted from the document and used to construct a new document. If false, the document will be sent as is. In this case, you must ensure the document validates without any errors against the relevant validation artifacts for that processId/documentTypeId. We automatically apply updates of the validation artificats, respecting the grace period provided by the issuer. During that period, documents that validate against either the old as well as against the new artifacts are accepted. After the grace period, your document must validate against the new artifacts. You are also responsible for making sure your receiver is able to receive the updated document.
  • parseStrategy string? - How to parse the document. Only needed when parse == true.
  • processId string? - The process id of the document. Required when parse == false.

storecove: Routing

The different ways to send the invoice to the recipient. The publicIdentifiers are used to send via the Peppol network, if the recipient is not registered on the Peppol network, the invoice will be sent to the email addresses in the emails property. This property is only mandatory when sending the invoice data using the <<_openapi_invoice>> property, not when sending using the <<_openapi_invoicedata>> property, in which case this information will be extracted from the <<_openapi_invoicedata>> object. If you do specify an <<_openapi_invoicerecipient>> object and an <<_openapi_invoicedata>> object, the data from the two will be merged.

Fields
  • eIdentifiers EIdentifiers? - A list of electronic routing identifiers. These are the identifiers used on the Peppol network or for other destinations.
  • emails string[]? - The email addresses the invoice should be sent to if none of the other identifiers can be used

storecove: RoutingIdentifier

An electronic routing identifier.

Fields
  • id string? - The actual identifier.
  • scheme string? - The scheme of the identifier. See <<_peppol_participant_identifier_list>> for a list.

storecove: SendableDocument

The document to send.

Fields
  • documentType string - The type of document to be sent.
  • invoice Invoice? - The invoice to send. Provide either invoice, or invoiceData, but not both.
  • rawDocumentData RawDocumentData? - A document to send, in base64 encoded format.

storecove: SupplierParty

A party that can send invoices

Fields
  • contact Contact? - Contact details for the invoice

storecove: Tax

Tax

Fields
  • amount decimal? - The amount of tax. Mandatory if taxSystem == 'tax_line_amounts'. However, it is best to use taxSystem tax_line_percentages and provide only the percentage, not the actual amount. The amount is then provided at the invoice level, in the taxSubtotals element.
  • category string? - The optional category code for the tax. This is not mandatory, but highly recommended. If not provided, it will be automatically derived from the country/percentage in combination with the invoice taxPointDate (which defaults to the issueDate), but there are situations in which this fails and the category needs to be specified explicitly. In particular, there are multiple categories available for 0%. The allowed values depend on the country of the tax.
  • country Country - An ISO 3166-1 alpha-2 country code.
  • percentage decimal? - The percentage Tax. This should be a valid Tax percentage in the country at the time of the issueDate of this invoice. Mandatory if taxSystem == 'tax_line_percentages'

storecove: TaxSubtotal

The total amount of tax of this type in the invoice.

Fields
  • category string? - The tax category. For a description see <<_openapi_tax>>
  • country Country? - An ISO 3166-1 alpha-2 country code.
  • percentage decimal? - The tax percentage. This should be a valid tax percentage in the country at the time of the taxpointDate of this invoice. Required unless taxAmount is provided.
  • taxAmount decimal? - The amount of tax.
  • taxableAmount decimal - The amount on which the tax is levied. Required unless percentage is provided.

storecove: ThePaymentTerms

The payment terms of the invoice.

Fields
  • note string? - The note for the payment terms.

storecove: VatDetails

The VAT details for the invoice line.

Fields
  • amount decimal? - The amount of VAT for the invoice line.
  • country string? - The ISO 3166 country of the VAT for the invoice line.
  • percentage decimal? - The percentage of VAT for the invoice line.

storecove: WebhookInstance

Fields
  • body string? - The webhook body that would have been pushed if this were a push-mode webhook.
  • guid string? - The GUID of the WebhookInstance. Use this to delete it.

String types

storecove: Country

string

Country

An ISO 3166-1 alpha-2 country code.

storecove: CurrencyCode

string

CurrencyCode

The ISO 4217 currency code.

Import

import ballerinax/storecove;Copy

Metadata

Released date: 12 months ago

Version: 1.5.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 0

Current verison: 0

Weekly downloads

Source repository

Keywords

Finance/Billing

Cost/Freemium

Contributors

Other versions

1.5.1

1.5.01.4.01.2.01.1.0
See more...

Dependencies

ballerina/url/2.2.3ballerina/constraint/1.1.0ballerina/http/2.6.1

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2024 WSO2 LLC