API docs by Redocly

Aptic API Gateway - Invoices (v1.0)

Download OpenAPI specification:Download

Aptic AB: api@aptic.net URL: https://www.aptic.net Terms of Service

Invoice related API for Aptic solutions

Invoices

Get invoices using filters

Authorizations:
(oauth2apikey)
query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Creates a new invoice

Authorizations:
(oauth2apikey)
Request Body schema:
Array
creditorReference
string or null

Party reference code.

referenceNumber
string or null

Customer reference number.

deliverySystemCode
string or null

Delivery system code.

paymentReference
string or null

Payment reference.

service
string or null

Service name (Invoicing / ReceivableLdg / Paymentplan / PreCollection / Collection / Legal / Surveillance / External / JournalCase). This is default values that may be used as servicecode but via configuration changes may be made, for an exact list, contact the service provider.

tryComplementExisting
boolean or null

If we need to try to complement existing matching invoice with debt rows instead of creating a new one

claimantName
string or null

Claimant name.

loanFlag
boolean or null

Is debt loan functionality enabled for invoice.

loanPercent
number or null <double>

Amount to be disbursed for invoice (percent of invoice amount). If not indicated, creditor settings used

purchasable
integer or null <int32>

Is invoice purchasable. 0 = Not purchasable, 1 = Purchaseble, 2 = Purchasble only with regress

purchaseFee
string or null

Purchase fee.

invoiceDate
string or null <date-time>

Date of invoice.

paymentCode
string or null

Payment code.

printCode
string or null

Print code (currently one of predefined values EMAIL / PRINT / EMAIL; PRINT / FAKTURA).

formCode
string or null

Form code (currently one of predefined values MALL1 / PRINTTEST / DUSTIN / Invoice1 / temp / PRINT / DUSTIN_KVITTO).

receiverReference
string or null

Receiver reference - usualy e-mail address.

aconto
boolean or null

Is payment account 'aconto' (special type of account supposing partial payments of total cost).

denyConversion
boolean or null

Is conversion to revolving credit allowed.

accountingFactor
number or null <double>

Accounting factor (percentage of system amount).

preferredChannel
string or null

Preferred way of communication (Letter / Email / SMS / E-invoice).

externalReferenceCode
string or null

External ledger reference code.

paymentProductCode
string or null

Payment product code (ACCOUNT / INVOICE or some others).

marketplaceReferenceCode
string or null

Marketplace reference code.

object (PutInvoiceCustomer)

Holds customer information.

Array of objects or null (InvoiceDebt)

List of debts for the invoice.

Array of objects or null (InvoiceFee)

List of fees for the invoice.

Array of objects or null (PutExtraFieldValue)

List of extra fields for the invoice.

Array of objects or null (InvoiceNote)

List of notes for the invoice.

Array of objects or null (PutDocument)

List of documents for the invoice.

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "invoiceGuids": [
    ],
  • "impStockId": 0
}

Get invoice details.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The GUID representing the invoice.

Responses

Response samples

Content type
{
  • "creditorReference": "string",
  • "invoiceNumber": "string",
  • "deliverySystemCode": "string",
  • "paymentReference": "string",
  • "service": "string",
  • "claimantName": "string",
  • "invoiceDat": "2019-08-24T14:15:22Z",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "purchased": true,
  • "paymentCode": "string",
  • "printCode": "string",
  • "formCode": "string",
  • "receiverReference": "string",
  • "preferredChannel": "string",
  • "externalReferenceCode": "string",
  • "paymentProductCode": "string",
  • "marketplaceReferenceCode": "string",
  • "financeStatus": 0,
  • "customer": {
    },
  • "debts": [
    ],
  • "fees": [
    ],
  • "registrationDate": "2019-08-24T14:15:22Z",
  • "links": [
    ]
}

Get invoice financial details.

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string

The GUID representing the invoice.

Responses

Response samples

Content type
{
  • "financialInterestInformation": {
    },
  • "purchaseInformation": {
    },
  • "creditorFeeInformation": [
    ]
}

Updates an invoice

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string
Request Body schema:
dueDate
string or null <date>

Due date of the invoice.

paymentCondition
string or null

Payment condition.

paymentReference
string or null

Payment reference.

receiverReference
string or null

Receiver reference.

ourOrder
string or null

Our order number.

yourOrder
string or null

Your order number.

ourReference
string or null

Our reference.

yourReference
string or null

Your reference.

seller
string or null

Seller.

handlingCode
string or null

Handling code.

goodsMark
string or null

Goods mark.

preferredChannelId
integer or null <int32>

Preferred channel ID.

denyConversion
boolean or null

Deny conversion flag.

paymentCode
string or null

Payment code.

printCode
string or null

Print code.

formCode
string or null

Form code.

interestCapitalizationInterval
integer or null <int32>

Interest capitalization interval.

priceList
string or null

Price list name.

debtGroup
string or null

Debt group code.

receiverHomePhone
string or null

Receiver home phone.

receiverWorkPhone
string or null

Receiver work phone.

receiverCellularPhone
string or null

Receiver cellular phone.

receiverTelefax
string or null

Receiver telefax.

receiverEmail
string or null

Receiver email.

reminderDate
string or null <date>

Reminder date.

collectionDate
string or null <date>

Collection date.

Responses

Request samples

Content type
{
  • "dueDate": "2019-08-24",
  • "paymentCondition": "string",
  • "paymentReference": "string",
  • "receiverReference": "string",
  • "ourOrder": "string",
  • "yourOrder": "string",
  • "ourReference": "string",
  • "yourReference": "string",
  • "seller": "string",
  • "handlingCode": "string",
  • "goodsMark": "string",
  • "preferredChannelId": 0,
  • "denyConversion": true,
  • "paymentCode": "string",
  • "printCode": "string",
  • "formCode": "string",
  • "interestCapitalizationInterval": 0,
  • "priceList": "string",
  • "debtGroup": "string",
  • "receiverHomePhone": "string",
  • "receiverWorkPhone": "string",
  • "receiverCellularPhone": "string",
  • "receiverTelefax": "string",
  • "receiverEmail": "string",
  • "reminderDate": "2019-08-24",
  • "collectionDate": "2019-08-24"
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Get invoice extra fields using filters

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string

Invoice guid

query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Creates a new invoice extra field

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string

Invoice guid

Request Body schema:

Extra field value

name
string or null

Name of Extra field data

value
Array of strings or null

The value of the extra field

Responses

Request samples

Content type
{
  • "name": "string",
  • "value": [
    ]
}

Response samples

Content type
{
  • "name": "string",
  • "value": [
    ]
}

Get invoice extra field details based on the unique GUID and extra field name

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string

The unique GUID of the invoice

name
required
string

The name of the extra field

Responses

Response samples

Content type
{
  • "name": "string",
  • "value": [
    ]
}

Updates an invoiceextra field

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string

Invoice guid

name
required
string

Extrafield name

Request Body schema:

Extrafield value

value
Array of strings or null

The value of the extra field

Responses

Request samples

Content type
{
  • "value": [
    ]
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Deletes an invoice extra field

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string

Invoice guid

name
required
string

Extrafield name

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Get invoice credit insurances using filters

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string

Invoice guid

query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Creates a new credit insurance for the invoice

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string

Invoice guid

Request Body schema:

Credit insurance information

insuranceCompanyReferenceCode
string or null

Reference code of the credit insurance company, eg. ATRADIUS, EULERHERMES.

insuranceCompanyNumber
string or null

Reference number at the credit insurance company.

insuranceCompanyCustomerNumber
string or null

Customer number at the credit insurance company.

note
string or null

Free text note

endDate
string or null <date-time>

End date for the credit insurance

currencyCode
string or null

Currency code of the insured amount

amount
number or null <double>

The insured amount

extraLimitAmount
number or null <double>

The extra limit amount caused by the credit insurance

extraLimitEndDate
string or null <date-time>

End date for the extra limit

paymentTerm
integer or null <int32>

The payment term

graceDays
integer or null <int32>

Grace days

Responses

Request samples

Content type
{
  • "insuranceCompanyReferenceCode": "string",
  • "insuranceCompanyNumber": "string",
  • "insuranceCompanyCustomerNumber": "string",
  • "note": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "currencyCode": "string",
  • "amount": 0,
  • "extraLimitAmount": 0,
  • "extraLimitEndDate": "2019-08-24T14:15:22Z",
  • "paymentTerm": 0,
  • "graceDays": 0
}

Response samples

Content type
{
  • "insuranceGuid": "string",
  • "insuranceDate": "2019-08-24T14:15:22Z",
  • "insuranceCompanyName": "string",
  • "insuranceCompanyNumber": "string",
  • "insuranceCompanyCustomerNumber": "string",
  • "note": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "currencyCode": "string",
  • "amount": 0,
  • "extraLimitAmount": 0,
  • "extraLimitEndDate": "2019-08-24T14:15:22Z",
  • "paymentTerm": 0,
  • "graceDays": 0,
  • "links": [
    ]
}

Get invoice credit insurance details based on the unique GUID for invoice and credit insurance

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string

The unique GUID of the invoice

insuranceGuid
required
string

The unique GUID of the credit insurance

Responses

Response samples

Content type
{
  • "insuranceGuid": "string",
  • "insuranceDate": "2019-08-24T14:15:22Z",
  • "insuranceCompanyName": "string",
  • "insuranceCompanyNumber": "string",
  • "insuranceCompanyCustomerNumber": "string",
  • "note": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "currencyCode": "string",
  • "amount": 0,
  • "extraLimitAmount": 0,
  • "extraLimitEndDate": "2019-08-24T14:15:22Z",
  • "paymentTerm": 0,
  • "graceDays": 0,
  • "links": [
    ]
}

Updates an invoice credit insurance

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string

Invoice guid

insuranceGuid
required
string

Credit insurance GUID

Request Body schema:

New credit insurance information

insuranceCompanyNumber
string or null

Reference number at the credit insurance company.

insuranceCompanyCustomerNumber
string or null

Customer number at the credit insurance company.

note
string or null

Free text note

endDate
string or null <date-time>

End date for the credit insurance

currencyCode
string or null

Currency code of the insured amount

amount
number or null <double>

The insured amount

extraLimitAmount
number or null <double>

The extra limit amount caused by the credit insurance

extraLimitEndDate
string or null <date-time>

End date for the extra limit

paymentTerm
integer or null <int32>

The payment term

graceDays
integer or null <int32>

Grace days

Responses

Request samples

Content type
{
  • "insuranceCompanyNumber": "string",
  • "insuranceCompanyCustomerNumber": "string",
  • "note": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "currencyCode": "string",
  • "amount": 0,
  • "extraLimitAmount": 0,
  • "extraLimitEndDate": "2019-08-24T14:15:22Z",
  • "paymentTerm": 0,
  • "graceDays": 0
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Deletes an invoice credit insurance

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string

Invoice guid

insuranceGuid
required
string

Credit insurance GUID

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Get invoice documents using filters

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string

Invoice guid

query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Adds a document to the invoice

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string

Invoice guid

Request Body schema:

Document information

note
required
string non-empty

Free extra information related to the document.

documentType
string or null

Document code (one of predefined types idoc / invoice / gjeldsbrev / verdict / domforlik).

loggedAt
string or null <date-time>

Document creation date.

originalFileName
required
string non-empty

The file name to be generated instead of an auto-generated one.

searchValue
string or null

Document specific search value or reference number.

externalLink
string or null

Link to the document, if it exists on external archive.

important
boolean or null

Document importancy flag.

fileDataBase64
string or null

Base64-encoded file body.

Responses

Request samples

Content type
{
  • "note": "string",
  • "documentType": "string",
  • "loggedAt": "2019-08-24T14:15:22Z",
  • "originalFileName": "string",
  • "searchValue": "string",
  • "externalLink": "string",
  • "important": true,
  • "fileDataBase64": "string"
}

Response samples

Content type
{
  • "note": "string",
  • "documentType": "string",
  • "loggedAt": "2019-08-24T14:15:22Z",
  • "originalFileName": "string",
  • "important": true,
  • "links": [
    ]
}

Get invoice document details based on the unique GUID for invoice and document

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string

The unique GUID of the invoice

documentGuid
required
string

The unique GUID of the document

Responses

Response samples

Content type
{
  • "note": "string",
  • "documentType": "string",
  • "loggedAt": "2019-08-24T14:15:22Z",
  • "originalFileName": "string",
  • "important": true,
  • "links": [
    ]
}

Get invoice transactions using filters

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string

Invoice guid

query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "summary": {
    },
  • "values": [
    ]
}

Creates a new invoice transaction

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string
Request Body schema:
Array
Array of objects or null (PutTransactionData)

List of transactions.

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "import_Date": "2019-08-24T14:15:22Z",
  • "sum_Amount": 0,
  • "number_Of_Transactions": 0
}

Reverse an invoice transaction

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string
Request Body schema:
Array
Array of objects or null (DeleteTransactionData)

List of transactions.

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
{
  • "revertedDate": "2019-08-24T14:15:22Z",
  • "transactionsReverted": 0
}

Register a direct payment on the invoice

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string

Invoice guid

Request Body schema:

Payment information

paymentReference
string or null

Payment reference string

paymentDate
string <date-time>

Payment date

accountingDate
string or null <date-time>

Accounting date for G/L

paymentAmount
number <double>

Total paid amount

currencyCode
string or null

The currency the paid payment

receivedAmount
number or null <double>

Received amount in G/L currency

exchangeDate
string or null <date-time>

Date for currency exchange

source
string or null

Information of the origin of the payment

Responses

Request samples

Content type
{
  • "paymentReference": "string",
  • "paymentDate": "2019-08-24T14:15:22Z",
  • "accountingDate": "2019-08-24T14:15:22Z",
  • "paymentAmount": 0,
  • "currencyCode": "string",
  • "receivedAmount": 0,
  • "exchangeDate": "2019-08-24T14:15:22Z",
  • "source": "string"
}

Response samples

Content type
{
  • "paymentGuid": "string",
  • "paymentReference": "string",
  • "paymentDate": "2019-08-24T14:15:22Z",
  • "accountingDate": "2019-08-24T14:15:22Z",
  • "paymentAmount": 0,
  • "currencyCode": "string",
  • "receivedAmount": 0,
  • "exchangeDate": "2019-08-24T14:15:22Z",
  • "source": "string"
}

Disputes an invoice

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string

Invoice guid

Request Body schema:

Dispute information

reason
string or null

Reason for the disbute

disputedAt
string or null <date-time>

Date when the customer disputed the invoice.

isDisputed
boolean or null

Flag if the invoice is disputed. When IsDisputed = false, the dispute is marked as resolved

Responses

Request samples

Content type
{
  • "reason": "string",
  • "disputedAt": "2019-08-24T14:15:22Z",
  • "isDisputed": true
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Deprecate an invoice

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string

Invoice guid

Request Body schema:

Deprecate information

deprecationLevel
string (DeprecationLevel)
Enum: "Reservation" "WriteOff"

Enumerator for DeprecationLevel

deprecatedAt
string or null <date-time>

Date when the invoice was deprecated.

note
string or null

Note connected to the depreciation.

Responses

Request samples

Content type
{
  • "deprecationLevel": "Reservation",
  • "deprecatedAt": "2019-08-24T14:15:22Z",
  • "note": "string"
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Close an invoice

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string
Request Body schema:

Closure information

closureCode
string or null

Closure code

note
string or null

Closure note.

Responses

Request samples

Content type
{
  • "closureCode": "string",
  • "note": "string"
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Get invoice on-hold status

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string

Invoice guid

query Parameters
initialValues
boolean

Initial values

Responses

Response samples

Content type
{
  • "values": {
    },
  • "options": { }
}

Set invoice on-hold status

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string

Invoice guid

Request Body schema:

On-hold status

object (OnHoldValues)
object (OnHoldOptions)

Responses

Request samples

Content type
{
  • "values": {
    },
  • "options": { }
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Postpone invoice due date

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string

Invoice guid

Request Body schema:

New due date

newDueDate
string <date-time>

New due date

Responses

Request samples

Content type
{
  • "newDueDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Get invoice purchase status

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string

Invoice guid

query Parameters
initialValues
boolean

Initial values

Responses

Response samples

Content type
{
  • "values": {
    },
  • "options": { }
}

Purchases an invoice

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string

Invoice guid

Request Body schema:

Purchase information

purchaseFeeAmount
number or null <double>

Purchase fee (will be calculated if omitted)

purchaseFeeCurrency
string or null

Currency code of purchase fee

purchaseFeePercentage
number or null <double>

Purchase fee in percent

invoiceItemId
integer or null <int32>

Sets the invoice item id.

approved
boolean or null

Sets if the purchase is approved. Default is true.

recourseDays
integer or null <int32>

Purchase invoice with recourse rights

depositAmount
number or null <double>

Optional amount kept as deposit until payment from customer

note
string or null

Any additional note

Responses

Request samples

Content type
{
  • "purchaseFeeAmount": 0,
  • "purchaseFeeCurrency": "string",
  • "purchaseFeePercentage": 0,
  • "invoiceItemId": 0,
  • "approved": true,
  • "recourseDays": 0,
  • "depositAmount": 0,
  • "note": "string"
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Get invoice recourse

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string

Invoice guid

query Parameters
initialValues
boolean

Initial values

Responses

Response samples

Content type
{
  • "values": {
    },
  • "options": { }
}

Recourses a purchased invoice

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string

Invoice guid

Request Body schema:

Recourse information

reason
string or null

Reason for the recourse

recourseFee
number or null <double>

Additional fee for recoursing the invoice

recourseFeeCurrency
string or null

Currency code of recourse fee

Responses

Request samples

Content type
{
  • "reason": "string",
  • "recourseFee": 0,
  • "recourseFeeCurrency": "string"
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Applies a credit invoice

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string

Credit invoice guid

Request Body schema:

Information about how credit invoice should be applied

creditInvoiceGuid
string or null

Credit invoice guid

deductionOrder
string or null

Deduction order

Array of objects or null (CreditInvoicePlacementInfo)

List of invoices that the credit invoice should be placed against

Responses

Request samples

Content type
{
  • "creditInvoiceGuid": "string",
  • "deductionOrder": "string",
  • "placements": [
    ]
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Get chart based on a service definition.

Authorizations:
(oauth2apikey)
path Parameters
serviceDefinition
required
string

The invoke service definition request.

query Parameters
Guid
string

A guid that is served to a service definition

Responses

Response samples

Content type
{
  • "systemCurrency": "string",
  • "totalAmount": 0,
  • "lastUpdatedAt": "2019-08-24T14:15:22Z",
  • "charts": [
    ],
  • "distributions": [
    ],
  • "links": [
    ]
}

Invokes a custom action based on a service definition.

Execute custom service definition in CLVR with possibility to pass in JSON into definition.

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string

Invoice unique id

serviceDefinition
required
string

The invoke service definition request.

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Request Body schema:

JSON body

any

Responses

Request samples

Content type
{
  • "name1": "string",
  • "name2": false,
  • "name3": {
    }
}

Response samples

Content type
{ }

Invokes a custom action based on a service definition.

Execute custom service definition in CLVR with possibility to pass in JSON into definition.

Authorizations:
(oauth2apikey)
path Parameters
serviceDefinition
required
string

The invoke service definition request.

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Request Body schema:

JSON body

any

Responses

Request samples

Content type
{
  • "name1": "string",
  • "name2": false,
  • "name3": {
    }
}

Response samples

Content type
{ }

Make a ping request to see that the service is up and running.

This operation enables to check if service is available. The service will return code 200 and an empty json object.

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{ }