API docs by Redocly

AbaNinja API (2.0.3)

Download OpenAPI specification:Download

ABACUS Research AG: [email protected] URL: https://www.abacus.ch License: MIT

This is the AbaNinja API documentation

Addresses

Manage addresses

Get a list of company addresses for given account

This return a list of available company addresses for the given account

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>
query Parameters
page
integer <int64>
limit
integer <int64>
tags[]
Array of strings

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Single company

Returns data for one company only

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>
companyUuid
required
string <uuid>

The id of the address

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Single company update

Updates single company

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>
companyUuid
required
string <uuid>

The id of the address

Request Body schema: application/json

Addressfields to update

type
required
string
Value: "company"
uuid
required
string <uuid>
customer_number
string
name
required
string
id_number
string
vat_number
string
currency_code
string
language
string
Array of objects (AddressesContactPerson)
tags
Array of strings
Array of objects (AddressesContact)
Array of objects (AddressesAddress)
private_notes
string
automatic_dunning
boolean
payment_terms
integer
Enum: -1 7 10 14 15 20 30 60 90

Responses

Request samples

Content type
application/json
{
  • "type": "company",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer_number": "string",
  • "name": "string",
  • "id_number": "string",
  • "vat_number": "string",
  • "currency_code": "string",
  • "language": "string",
  • "contact_persons": [
    ],
  • "tags": [
    ],
  • "contacts": [
    ],
  • "addresses": [
    ],
  • "private_notes": "string",
  • "automatic_dunning": true,
  • "payment_terms": -1
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_description": "string"
}

Delete company

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>
companyUuid
required
string <uuid>

The id of the address

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_description": "string"
}

Get a list of person addresses for given account

This return a list of available company addresses for the given account

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>
query Parameters
page
integer <int64>
limit
integer <int64>
tags[]
Array of strings

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Single person access

Returns data for one company only

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>
personUuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Single person update

Updates single person

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>
personUuid
required
string <uuid>
Request Body schema: application/json

Addressfields to update

type
required
string
Value: "person"
uuid
required
string <uuid>
first_name
required
string
last_name
required
string
salutation
string
Enum: "Mr" "Ms" "Family"
currency_code
string
language
string
Array of objects (AddressesContact)
tags
Array of strings
Array of objects (AddressesAddress)
private_notes
string
automatic_dunning
boolean
payment_terms
integer
Enum: -1 7 10 14 15 20 30 60 90

Responses

Request samples

Content type
application/json
{
  • "type": "person",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "first_name": "string",
  • "last_name": "string",
  • "salutation": "Mr",
  • "currency_code": "string",
  • "language": "string",
  • "contacts": [
    ],
  • "tags": [
    ],
  • "addresses": [
    ],
  • "private_notes": "string",
  • "automatic_dunning": true,
  • "payment_terms": -1
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_description": "string"
}

Delete person

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>
personUuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_description": "string"
}

Create new address for given account

Creating a new address in AbaNinja

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>
query Parameters
force
boolean

Force saving of Address. Even when duplicates were found. Default: false

Request Body schema: application/json

New Address

One of
type
required
string
Value: "company"
customer_number
string
name
required
string
id_number
string
vat_number
string
currency_code
string
language
string
Array of objects (AddressesContactBody)
tags
Array of strings
Array of objects (AddressesContactPersonBody)
Array of objects (AddressesAddressBody)
private_notes
string
automatic_dunning
boolean
payment_terms
integer
Enum: -1 7 10 14 15 20 30 60 90

Responses

Request samples

Content type
application/json
Example
{
  • "type": "company",
  • "customer_number": "string",
  • "name": "string",
  • "id_number": "string",
  • "vat_number": "string",
  • "currency_code": "string",
  • "language": "string",
  • "contacts": [
    ],
  • "tags": [
    ],
  • "contact_persons": [
    ],
  • "addresses": [
    ],
  • "private_notes": "string",
  • "automatic_dunning": true,
  • "payment_terms": -1
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

DocumentsQuotes

Manage Quotes

Quotes List

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

query Parameters
sort
string
direction
string
page
integer
per_page
integer
Example: per_page=integer | all
search
string
extend_search
Array of objects
Example: extend_search=<column>_<extend-param>=<value>

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Create a quote

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the quote should be created

Request Body schema: application/json
schemaVersion
required
any

Schema Version

Value: "2.0.0"
required
Array of objects (singleQuote) non-empty

Responses

Request samples

Content type
application/json
{
  • "schemaVersion": "2.0.0",
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Existing quote

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of quote

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update a quote

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the quote should be created

documentUuid
required
string <uuid>

UUID of quote

Request Body schema: application/json
schemaVersion
required
any

Schema Version

Value: "2.0.0"
required
Array of objects (singleQuote) non-empty

Responses

Request samples

Content type
application/json
{
  • "schemaVersion": "2.0.0",
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Actions for an existing quote

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of quote

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Execute an action on an existing quote

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of quote

action
required
string

Name of action

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "string"
}

DocumentsContractNotes

Manage Contract Notes

Contract Notes List

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

query Parameters
sort
string
direction
string
page
integer
per_page
integer
Example: per_page=integer | all
search
string
extend_search
Array of objects
Example: extend_search=<column>_<extend-param>=<value>

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Create contract note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the contract note should be created

Request Body schema: application/json
schemaVersion
required
any

Schema Version

Value: "2.0.0"
required
Array of objects (singleContractNote) non-empty

Responses

Request samples

Content type
application/json
{
  • "schemaVersion": "2.0.0",
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Existing contract note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of contract-note

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update contract note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the contract note should be created

documentUuid
required
string <uuid>

UUID of contract-note

Request Body schema: application/json
schemaVersion
required
any

Schema Version

Value: "2.0.0"
required
Array of objects (singleContractNote) non-empty

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Actions for an existing contract note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of contract note

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Execute an action on an existing contract note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of contract note

action
required
string

Name of action

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "string"
}

DocumentsDeliveryNotes

Manage Delivery Notes

Delivery Notes List

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

query Parameters
sort
string
direction
string
page
integer
per_page
integer
Example: per_page=integer | all
search
string
extend_search
Array of objects
Example: extend_search=<column>_<extend-param>=<value>

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Create delivery note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the delivery note should be created

Request Body schema: application/json
schemaVersion
required
any

Schema Version

Value: "2.0.0"
required
Array of objects (singleDeliveryNote) non-empty

Responses

Request samples

Content type
application/json
{
  • "schemaVersion": "2.0.0",
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Existing delivery note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of contract-note

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update delivery note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the delivery note should be created

documentUuid
required
string <uuid>

UUID of contract-note

Request Body schema: application/json
schemaVersion
required
any

Schema Version

Value: "2.0.0"
required
Array of objects (singleDeliveryNote) non-empty

Responses

Request samples

Content type
application/json
{
  • "schemaVersion": "2.0.0",
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Actions for an existing delivery note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of delivery note

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Execute an action on an existing delivery note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of delivery note

action
required
string

Name of action

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "string"
}

DocumentsInvoices

Manage Invoices

Invoices List

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

query Parameters
sort
string
direction
string
page
integer
per_page
integer
Example: per_page=integer | all
search
string
extend_search
Array of objects
Example: extend_search=<column>_<extend-param>=<value>

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Create invoice

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the invoice should be created

Request Body schema: application/json
schemaVersion
required
any

Schema Version

Value: "2.0.0"
required
Array of objects (singleInvoice) non-empty

Responses

Request samples

Content type
application/json
{
  • "schemaVersion": "2.0.0",
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Existing invoice

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of contract-note

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update invoice

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the invoice should be created

documentUuid
required
string <uuid>

UUID of contract-note

Request Body schema: application/json
schemaVersion
required
any

Schema Version

Value: "2.0.0"
required
Array of objects (singleInvoice) non-empty

Responses

Request samples

Content type
application/json
{
  • "schemaVersion": "2.0.0",
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Actions for an existing invoice

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of invoice

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Execute an action on an existing invoice

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of invoice

action
required
string

Name of action

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "string"
}

DocumentsInvoicesImported

Manage Invoices (Existing PDF)

Create an imported invoice (PDF existing)

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the invoice should be imported to

Request Body schema: application/json
schemaVersion
required
any

Schema Version

Value: "2.0.0"
required
Array of objects (singleDocument) non-empty

Responses

Request samples

Content type
application/json
{
  • "schemaVersion": "2.0.0",
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

DocumentsCreditNotes

Manage Credit Notes

Credit Notes List

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

query Parameters
sort
string
direction
string
page
integer
per_page
integer
Example: per_page=integer | all
search
string
extend_search
Array of objects
Example: extend_search=<column>_<extend-param>=<value>

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Create credit note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the credit note should be created

Request Body schema: application/json
schemaVersion
required
any

Schema Version

Value: "2.0.0"
required
Array of objects (singleCreditNote) non-empty

Responses

Request samples

Content type
application/json
{
  • "schemaVersion": "2.0.0",
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Existing credit note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of contract-note

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update credit note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the credit note should be created

documentUuid
required
string <uuid>

UUID of contract-note

Request Body schema: application/json
schemaVersion
required
any

Schema Version

Value: "2.0.0"
required
Array of objects (singleCreditNote) non-empty

Responses

Request samples

Content type
application/json
{
  • "schemaVersion": "2.0.0",
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Actions for an existing credit note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of credit note

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Execute an action on an existing credit note

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of credit note

action
required
string

Name of action

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "string"
}

DocumentsRecurringInvoices

Manage Recurring Invoices

Recurring Invoices List

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

query Parameters
sort
string
direction
string
page
integer
per_page
integer
Example: per_page=integer | all
search
string
extend_search
Array of objects
Example: extend_search=<column>_<extend-param>=<value>

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Create recurring invoice

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the recurring invoice should be created

Request Body schema: application/json
schemaVersion
required
any

Schema Version

Value: "2.0.0"
required
Array of objects (singleRecurringInvoice) non-empty

Responses

Request samples

Content type
application/json
{
  • "schemaVersion": "2.0.0",
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Existing recurring invoice

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of contract-note

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update recurring invoice

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the recurring invoice should be created

documentUuid
required
string <uuid>

UUID of contract-note

Request Body schema: application/json
schemaVersion
required
any

Schema Version

Value: "2.0.0"
required
Array of objects (singleRecurringInvoice) non-empty

Responses

Request samples

Content type
application/json
{
  • "schemaVersion": "2.0.0",
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Actions for an existing recurring invoice

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of recurring invoice

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Execute an action on an existing recurring invoice

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of recurring invoice

action
required
string

Name of action

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "string"
}

DocumentsTemplates

Manage Templates

TODO

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

query Parameters
sort
string
direction
string
page
integer
per_page
integer
Example: per_page=integer | all
search
string
extend_search
Array of objects
Example: extend_search=<column>_<extend-param>=<value>

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Create template

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the template should be created

Request Body schema: application/json
schemaVersion
required
any

Schema Version

Value: "2.0.0"
required
Array of objects (singleTemplate) non-empty

Responses

Request samples

Content type
application/json
{
  • "schemaVersion": "2.0.0",
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Existing template

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of contract-note

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Update template

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account where the template should be created

documentUuid
required
string <uuid>

UUID of contract-note

Request Body schema: application/json
schemaVersion
required
any

Schema Version

Value: "2.0.0"
required
Array of objects (singleTemplate) non-empty

Responses

Request samples

Content type
application/json
{
  • "schemaVersion": "2.0.0",
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

/accounts/{accountUuid}/documents/v2/templates/{documentUuid}/actions

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string <uuid>

UUID of template

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "message": "string",
  • "data": {
    }
}

Execute an action on an existing template

Authorizations:
accessCodebearerAuth
path Parameters
accountUuid
required
string <uuid>

UUID of account

documentUuid
required
string