Create a sales invoice service

Prev Next
Post
/api/v1/invoices/salesinvoiceservices

Create a new sales invoice service.

Description

This endpoint creates a new sales invoice service. Sales invoice services are simplified sales invoices and therefore contain less properties than the normal sales invoices. 

Use Case

The user wants to add a sales invoice service from outside the Bloxs application.

Request fields

The request contains the following fields:

FieldDescription
externalIdentifier
The unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system.
salesContractReference

The unique identifier for the related sales contract within Bloxs. This identifier is generated by the Bloxs system.

ownerReference

The unique identifier for the related owner within Bloxs. This identifier is generated by the Bloxs system.

relationReferenceThe unique identifier for the related relation (not being the owner) within Bloxs. This identifier is generated by the Bloxs system.
supplyDateThe actual supply date of the service. This date can differ from the invoice date.
paymentMethod

The method by which the invoice is expected to be paid. The following options are availabe:

1 = Direct debit

2 = Bank transfer

descriptionThe default description of the invoice service line. It can provide extra details in addition to the name of the invoice service line.
numberOfItemsThe number of items associated with this specific invoice service item. If for example the service is 'office rental per 1 hour', this value should contain '1'
serviceItemNameIncludes the name of the sales service line item. An example would be 'Office space rental 1 hour'.
realEstateObjectReference
The unique identifier for the real estate object related to the service item within Bloxs. This identifier is generated by the Bloxs system.
ledgerAccountCode
The ledger account code of this specific service item.
amountExclPerItemThe amount excluding VAT per item. Bloxs uses this field together with numberOfItems to calculate the amountExcl, amountVAT & amountIncl.
amountExclthe amount excluding VAT of this specific service item.
amountVATthe amount excluding VAT of this specific service item.
amountIncl.the amount excluding VAT of this specific service item.


Response fields

In addition to the fields in the request, the 200 response contains the fields in the table below. 

FieldDescription
referenceThe unique identifier for this sales invoice service within Bloxs. This is unique (per client specific environment) for all sales invoice services. This identifier is generated by the Bloxs system.
workflowState

Indicates the status of sales invoice service. Each number represents a status, which is described below:

1 = Draft

2 = OnHold

3 = Cancelled

4 = ApprovalWorkflow

7 = Final

9 = Disapproved

10 = OwnerApprovalWorkflow

11 = DisapprovedByOwner

totalAmountExclTotal amount excluding VAT.
totalAmountVATTotal VAT amount.
totalAmountInclTotal amount including VAT.
lineIndexThe order in which the line items are portrayed.
Security
HTTP
Type Bearer

Please enter a valid token

Body parameters
Expand All
object
externalIdentifier
string | null
Min length0
Max length100
salesContractReference
string | null
Min length0
Max length100
ownerReference
string Required
Min length0
Max length100
relationReference
string Required
Min length0
Max length100
supplyDate
string (date)
paymentMethod
integer (int32) Required
Valid values[ 1, 2 ]
Min length0
Max length256
lines
Array of object (SalesInvoiceServiceLine) | null
object
description
string | null
Min length0
Max length512
numberOfItems
integer (int32)
serviceItemName
string Required
Min length0
Max length256
realEstateObjectReference
string | null
Min length0
Max length100
amountExclPerItem
number (double)
amountExcl
number (double)
amountVAT
number (double)
amountIncl
number (double)
Responses
200

The sales invoice service was created

Expand All
object
reference
string
Min length0
Max length100
externalIdentifier
string | null
salesContractReference
string | null
Min length0
Max length100
ownerReference
string
Min length0
Max length100
relationReference
string
Min length0
Max length100
supplyDate
string (date)
paymentMethod
integer (int32)
Valid values[ 1, 2 ]
Min length0
Max length256
workflowState
integer (int32)
Valid values[ 1, 2, 3, 4, 7, 9, 10, 11 ]
totalAmountExcl
number (double)
totalAmountVAT
number (double)
totalAmountIncl
number (double)
lines
Array of object (SalesInvoiceServiceLineAPIDetailModel) | null
object
lineIndex
integer (int32)
description
string | null
numberOfItems
integer (int32)
amountExclPerItem
number (double) | null
amountExcl
number (double) | null
amountVAT
number (double) | null
amountIncl
number (double) | null
serviceItemName
string | null
realEstateObjectReference
string | null
400

The sales invoice service data has validation issues

Expand All
object
type
string | null
title
string | null
traceId
string | null
status
integer (int32)
errors
object | null
property*
Array of string | null additionalProperties
string