Update a client
This endpoint will update an existing client
path Parameters
id required | string <uuid> |
Request Body schema:
name required | string <string> non-empty Client name |
organizationNumber required | string <string> non-empty Organization Number |
adress1 required | string <string> non-empty Address line 1 |
address2 required | string <string> non-empty Address line 2 |
zipCode required | string <string> non-empty Zip code |
city required | string <string> non-empty County/City |
countryCode required | string <string> non-empty Country code (Alpha-2) |
bankNumber required | string <string> non-empty Bankgiro/Plusgiro |
email required | string <string> non-empty |
contactName required | string <string> non-empty Contact name |
contactEmail required | string <string> non-empty Contact email |
contactPhone required | string <string> non-empty Contact phonenumber |
Responses
Request samples
- Payload
{- "name": "string",
- "organizationNumber": "string",
- "adress1": "string",
- "address2": "string",
- "zipCode": "string",
- "city": "string",
- "countryCode": "string",
- "bankNumber": "string",
- "email": "string",
- "contactName": "string",
- "contactEmail": "string",
- "contactPhone": "string"
}
Response samples
- 400
Add a client
This endpoint will create a new client
Request Body schema:
name required | string <string> non-empty Client name |
organizationNumber required | string <string> non-empty Organization Number |
adress1 required | string <string> non-empty Address line 1 |
address2 required | string <string> non-empty Address line 2 |
zipCode required | string <string> non-empty Zip code |
city required | string <string> non-empty County/City |
countryCode required | string <string> non-empty Country code (Alpha-2) |
bankNumber required | string <string> non-empty Bankgiro/Plusgiro |
email required | string <string> non-empty |
contactName required | string <string> non-empty Contact name |
contactEmail required | string <string> non-empty Contact email |
contactPhone required | string <string> non-empty Contact phonenumber |
Responses
Request samples
- Payload
{- "name": "string",
- "organizationNumber": "string",
- "adress1": "string",
- "address2": "string",
- "zipCode": "string",
- "city": "string",
- "countryCode": "string",
- "bankNumber": "string",
- "email": "string",
- "contactName": "string",
- "contactEmail": "string",
- "contactPhone": "string"
}
Response samples
- 201
- 400
Update a debtor
This endpoint will update an existing debtor
path Parameters
id required | string <uuid> |
clientId required | string |
Request Body schema:
isCorporation required | boolean <bool> Set to true if the debtor is a corporation |
identificationNumber required | string <organization number / personal number> non-empty Organization number if IsCorporation is set to true, otherwise personal number |
name required | string <string> non-empty Name of debtor |
required | object (Address) |
object (ContactInformation) |
Responses
Request samples
- Payload
{- "isCorporation": true,
- "identificationNumber": "string",
- "name": "string",
- "address": {
- "address1": "string",
- "address2": "string",
- "careOf": "string",
- "zipCode": "string",
- "city": "string",
- "countryCode": "string"
}, - "contactInformation": {
- "email": "string",
- "phone": "string"
}
}
Response samples
- 400
List all debtors
This endpoint lists all debtors
path Parameters
clientId required | string |
query Parameters
PaymentStatus | integer <int32> |
ErrandStatus | integer <int32> |
ErrandProcessStatus | integer <int32> |
IsCompleted | boolean |
InvoiceCreatedDate | string <date-time> |
SearchType | integer <int32> |
ClientId | integer <int32> |
Page | integer <int32> |
RowsPerPage | integer <int32> |
Responses
Response samples
- 200
Add a debtor
This endpoint will create a new debtor
path Parameters
clientId required | string |
Request Body schema:
isCorporation required | boolean <bool> Set to true if the debtor is a corporation |
identificationNumber required | string <organization number / personal number> non-empty Organization number if IsCorporation is set to true, otherwise personal number |
name required | string <string> non-empty Name of debtor |
required | object (Address) |
object (ContactInformation) |
Responses
Request samples
- Payload
{- "isCorporation": true,
- "identificationNumber": "string",
- "name": "string",
- "address": {
- "address1": "string",
- "address2": "string",
- "careOf": "string",
- "zipCode": "string",
- "city": "string",
- "countryCode": "string"
}, - "contactInformation": {
- "email": "string",
- "phone": "string"
}
}
Response samples
- 201
- 400
Withdraw an invoice
This endpoint will withdraw an existing invoice
path Parameters
clientId required | string <uuid> |
id required | string <uuid> |
Request Body schema:
id required | string <uuid> |
Responses
Request samples
- Payload
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Response samples
- 400
List all invoices
This endpoint lists all invoices
path Parameters
clientId required | string |
query Parameters
PaymentStatus | integer <int32> |
InvoiceStatus | integer <int32> |
InvoiceProcessStatus | integer <int32> |
IsCompleted | boolean |
InvoiceCreatedDate | string <date-time> |
SearchType | integer <int32> |
ClientId | integer <int32> |
Page | integer <int32> |
RowsPerPage | integer <int32> |
Responses
Response samples
- 200
Add a invoice
This endpoint will create a new invoice
path Parameters
clientId required | string <uuid> |
Request Body schema:
invoiceNumber required | string <string> non-empty Unique invoice number |
invoiceDate required | string <date> Invoice date |
daysUntilExpiration required | integer <int> Number of days before expiration |
dueDate required | string <date> Due date |
interestRate | number or null <decimal> Interest rate |
totalExcludingVAT required | number <decimal> Total amount excluding VAT |
totalVATAmount required | number <decimal> Total VAT amount |
totalAmountIncludingVAT required | number <decimal> Total amount including VAT |
reminderDate | string or null <date> Reminder date |
reminderFee | number or null <decimal> Reminder fee |
required | Array of objects (Article) Articles |
Responses
Request samples
- Payload
{- "invoiceNumber": "string",
- "invoiceDate": "2019-08-24",
- "daysUntilExpiration": 0,
- "dueDate": "2019-08-24",
- "interestRate": 0,
- "totalExcludingVAT": 0,
- "totalVATAmount": 0,
- "totalAmountIncludingVAT": 0,
- "reminderDate": "2019-08-24",
- "reminderFee": 0,
- "articles": [
- {
- "name": "string",
- "description": "string",
- "priceExcludingVAT": 0,
- "totalVATAmount": 0,
- "totalAmountIncludingVAT": 0,
- "totalAmountExcludingVAT": 0,
- "quantity": 0,
- "vatPercentage": 0,
- "discount": 0
}
]
}
Response samples
- 201
- 400