API docs by Redocly

Aptic API Gateway - Supplier invoices (v1.0)

Download OpenAPI specification:

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

Supplier invoice related API for Aptic solutions

SupplierInvoices

Get supplier 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": [
    ]
}

Register a new supplier invoice

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

Client reference code.

supplierGuid
string or null

Supplier guid, if already registered.

supplierReference
string or null

Supplier reference code.

object (PutSupplierInvoiceCustomer)

Holds customer information.

deliverySystemCode
string or null

Delivery system code.

paymentReference
string or null

Payment reference.

invoiceDate
string <date-time>

Date of invoice.

dueDate
string <date-time>

Due date of invoice.

paymentDate
string or null <date-time>

Date when invoice is scheduled/has been paid

Array of objects or null (SupplierInvoiceDebt)

List of debts for the supplier invoice.

Array of objects or null (SupplierInvoiceFee)

List of fees for the supplier invoice.

Array of objects or null (PutExtraFieldValue)

List of extra fields for the supplier invoice.

Array of objects or null (SupplierInvoiceNote)

List of notes for the supplier invoice.

Array of objects or null (PutDocument)

List of documents for the supplier invoice.

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

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

Get invoice details.

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The GUID representing the invoice.

Responses

Response samples

Content type
{
  • "clientReference": "string",
  • "supplierReference": "string",
  • "invoiceNumber": "string",
  • "deliverySystemCode": "string",
  • "paymentReference": "string",
  • "invoiceDat": "2019-08-24T14:15:22Z",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "paymentDate": "2019-08-24T14:15:22Z",
  • "currencyCode": "string",
  • "originalPrincipal": 0.1,
  • "originalVAT": 0.1,
  • "isPaid": true,
  • "onHold": true,
  • "registrationDate": "2019-08-24T14:15:22Z",
  • "links": [
    ]
}

Updates an invoice

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

Due date of the SupplierInvoice.

paymentDate
string or null <date-time>

Date when invoice is scheduled/has been paid

paymentCondition
string or null

Payment condition.

onHold
boolean or null

Put the supplier invoice on hold to avoid paying it until the hold is removed

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.

ourEmail
string or null

Our email.

ourPhone
string or null

Our phone number.

goodsMark
string or null

Goods mark.

Responses

Request samples

Content type
{
  • "dueDate": "2019-08-24T14:15:22Z",
  • "paymentDate": "2019-08-24T14:15:22Z",
  • "paymentCondition": "string",
  • "onHold": true,
  • "paymentReference": "string",
  • "receiverReference": "string",
  • "ourOrder": "string",
  • "yourOrder": "string",
  • "ourReference": "string",
  • "yourReference": "string",
  • "ourEmail": "string",
  • "ourPhone": "string",
  • "goodsMark": "string"
}

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

SupplierInvoice 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

SupplierInvoice 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

SupplierInvoice 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

SupplierInvoice 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 documents using filters

Authorizations:
(oauth2apikey)
path Parameters
invoiceGuid
required
string

SupplierInvoice 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

SupplierInvoice 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": [
    ]
}

Register payment of a supplier 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.1,
  • "currencyCode": "string",
  • "receivedAmount": 0.1,
  • "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.1,
  • "currencyCode": "string",
  • "receivedAmount": 0.1,
  • "exchangeDate": "2019-08-24T14:15:22Z",
  • "source": "string"
}

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

supplierCreditInvoiceGuid
string or null

Supplier credit invoice guid

deductionOrder
string or null

Deduction order

Array of objects or null (CreditSupplierInvoicePlacementInfo)

List of SupplierInvoices that the credit SupplierInvoice should be placed against

Responses

Request samples

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

Response samples

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

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

SupplierInvoice 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
{ }