Invoice

API calls concerning invoices

Create a new invoice

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

clientId?string

contactEmail?string

currency*string

invoiceDate*string

Formatdate-time

mailBody?string

note?string

opportunityId?string

paymentReference?string

paymentTermDays*integer

Formatint32

recurringAutoSend?boolean

recurringEndDate?string

Formatdate-time

recurringIntervalDays?integer

Formatint32

recurringIntervalMonths?integer

Formatint32

recurringNextInvoiceDate?string

Formatdate-time

reminderBody?string

rows*array<>

subsidiaryId?string

Response Body

`application/json`

curl -X POST "http://localhost:18080/api/v1/invoices" \  -H "Content-Type: application/json" \  -d '{    "currency": "string",    "invoiceDate": "2019-08-24T14:15:22Z",    "paymentTermDays": 0,    "rows": [      {        "id": "string",        "quantity": 0.1,        "quantityType": "AMOUNT",        "taxAmount": 0.1,        "total": 0.1,        "totalWithTax": 0.1,        "type": "ITEM",        "unitPrice": 0.1      }    ]  }'

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contactEmail": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "datePaid": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "mailBody": "string",
  "milestoneId": "string",
  "note": "string",
  "opportunityId": "string",
  "overdueNotifiedAt": "2019-08-24T14:15:22Z",
  "paid": 0.1,
  "paidExcludingTax": 0.1,
  "paymentReference": "string",
  "paymentTermDays": 0,
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "recurringAgreement": {
    "autoSend": true,
    "endDate": "2019-08-24T14:15:22Z",
    "intervalDays": 0,
    "intervalMonths": 0,
    "nextInvoiceDate": "2019-08-24T14:15:22Z"
  },
  "reminderBody": "string",
  "reminders": [
    {
      "createdBy": "string",
      "sentOn": "2019-08-24T14:15:22Z"
    }
  ],
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "quantityType": "AMOUNT",
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "salesOrderId": "string",
  "sentMails": [
    "string"
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "total": 0.1,
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "transactions": [
    {
      "accountId": "string",
      "amount": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "paymentMethod": "CREDIT_CARD",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "type": "MANUAL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get invoices by opportunity

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

opportunityId*string

Response Body

`application/json`

curl -X GET "http://localhost:18080/api/v1/invoices/by-opportunity/string"

[
  {
    "attachments": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "clientId": "string",
    "contactEmail": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currency": "string",
    "datePaid": "2019-08-24T14:15:22Z",
    "dueDate": "2019-08-24T14:15:22Z",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "invoiceDate": "2019-08-24T14:15:22Z",
    "invoiceNumber": "string",
    "mailBody": "string",
    "milestoneId": "string",
    "note": "string",
    "opportunityId": "string",
    "overdueNotifiedAt": "2019-08-24T14:15:22Z",
    "paid": 0.1,
    "paidExcludingTax": 0.1,
    "paymentReference": "string",
    "paymentTermDays": 0,
    "pdf": {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    },
    "recurringAgreement": {
      "autoSend": true,
      "endDate": "2019-08-24T14:15:22Z",
      "intervalDays": 0,
      "intervalMonths": 0,
      "nextInvoiceDate": "2019-08-24T14:15:22Z"
    },
    "reminderBody": "string",
    "reminders": [
      {
        "createdBy": "string",
        "sentOn": "2019-08-24T14:15:22Z"
      }
    ],
    "rows": [
      {
        "description": "string",
        "id": "string",
        "productId": "string",
        "quantity": 0.1,
        "quantityType": "AMOUNT",
        "taxAmount": 0.1,
        "taxRate": 0.1,
        "total": 0.1,
        "totalWithTax": 0.1,
        "type": "ITEM",
        "unitPrice": 0.1
      }
    ],
    "salesOrderId": "string",
    "sentMails": [
      "string"
    ],
    "status": "DRAFT",
    "subsidiaryId": "string",
    "tenantId": "string",
    "total": 0.1,
    "totalExcludingTax": 0.1,
    "totalTax": 0.1,
    "totalWithTax": 0.1,
    "transactions": [
      {
        "accountId": "string",
        "amount": 0.1,
        "created": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "paymentMethod": "CREDIT_CARD",
        "tenantId": "string",
        "updated": "2019-08-24T14:15:22Z",
        "updatedBy": "string"
      }
    ],
    "type": "MANUAL",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Count invoices by status

Authorization

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "http://localhost:18080/api/v1/invoices/count-by-status"

{
  "property1": 0,
  "property2": 0
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Download Csv_ Invoice

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>

filters?array<>

page?integer

Default0

Formatint32

size?integer

Default20

Formatint32

sort?string

Response Body

`application/json`

curl -X GET "http://localhost:18080/api/v1/invoices/csv-export"

"string"

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get min and max invoice dates

Authorization

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "http://localhost:18080/api/v1/invoices/date-range"

{
  "property1": "2019-08-24T14:15:22Z",
  "property2": "2019-08-24T14:15:22Z"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Delete a list of invoices by their IDs

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids?array<>

Response Body

`application/json`

curl -X DELETE "http://localhost:18080/api/v1/invoices/delete-list"

Empty

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Dynamic Search_ Invoice

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>

filters?array<>

page?integer

Default0

Formatint32

size?integer

Default20

Formatint32

sort?string

Response Body

`application/json`

curl -X GET "http://localhost:18080/api/v1/invoices/dynamic-search"

{
  "content": [
    {
      "attachments": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "clientId": "string",
      "contactEmail": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "currency": "string",
      "datePaid": "2019-08-24T14:15:22Z",
      "dueDate": "2019-08-24T14:15:22Z",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "invoiceDate": "2019-08-24T14:15:22Z",
      "invoiceNumber": "string",
      "mailBody": "string",
      "milestoneId": "string",
      "note": "string",
      "opportunityId": "string",
      "overdueNotifiedAt": "2019-08-24T14:15:22Z",
      "paid": 0.1,
      "paidExcludingTax": 0.1,
      "paymentReference": "string",
      "paymentTermDays": 0,
      "pdf": {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      },
      "recurringAgreement": {
        "autoSend": true,
        "endDate": "2019-08-24T14:15:22Z",
        "intervalDays": 0,
        "intervalMonths": 0,
        "nextInvoiceDate": "2019-08-24T14:15:22Z"
      },
      "reminderBody": "string",
      "reminders": [
        {
          "createdBy": "string",
          "sentOn": "2019-08-24T14:15:22Z"
        }
      ],
      "rows": [
        {
          "description": "string",
          "id": "string",
          "productId": "string",
          "quantity": 0.1,
          "quantityType": "AMOUNT",
          "taxAmount": 0.1,
          "taxRate": 0.1,
          "total": 0.1,
          "totalWithTax": 0.1,
          "type": "ITEM",
          "unitPrice": 0.1
        }
      ],
      "salesOrderId": "string",
      "sentMails": [
        "string"
      ],
      "status": "DRAFT",
      "subsidiaryId": "string",
      "tenantId": "string",
      "total": 0.1,
      "totalExcludingTax": 0.1,
      "totalTax": 0.1,
      "totalWithTax": 0.1,
      "transactions": [
        {
          "accountId": "string",
          "amount": 0.1,
          "created": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "paymentMethod": "CREDIT_CARD",
          "tenantId": "string",
          "updated": "2019-08-24T14:15:22Z",
          "updatedBy": "string"
        }
      ],
      "type": "MANUAL",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Dynamic Search Post_ Invoice

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

filters*

page*integer

Formatint32

search*array<>

size*integer

Formatint32

sort*array<>

Response Body

`application/json`

curl -X POST "http://localhost:18080/api/v1/invoices/dynamic-search" \  -H "Content-Type: application/json" \  -d '{    "filters": {      "property1": null,      "property2": null    },    "page": 0,    "search": [      "string"    ],    "size": 0,    "sort": [      {        "ascending": true,        "field": "string"      }    ]  }'

{
  "content": [
    {
      "attachments": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "clientId": "string",
      "contactEmail": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "currency": "string",
      "datePaid": "2019-08-24T14:15:22Z",
      "dueDate": "2019-08-24T14:15:22Z",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "invoiceDate": "2019-08-24T14:15:22Z",
      "invoiceNumber": "string",
      "mailBody": "string",
      "milestoneId": "string",
      "note": "string",
      "opportunityId": "string",
      "overdueNotifiedAt": "2019-08-24T14:15:22Z",
      "paid": 0.1,
      "paidExcludingTax": 0.1,
      "paymentReference": "string",
      "paymentTermDays": 0,
      "pdf": {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      },
      "recurringAgreement": {
        "autoSend": true,
        "endDate": "2019-08-24T14:15:22Z",
        "intervalDays": 0,
        "intervalMonths": 0,
        "nextInvoiceDate": "2019-08-24T14:15:22Z"
      },
      "reminderBody": "string",
      "reminders": [
        {
          "createdBy": "string",
          "sentOn": "2019-08-24T14:15:22Z"
        }
      ],
      "rows": [
        {
          "description": "string",
          "id": "string",
          "productId": "string",
          "quantity": 0.1,
          "quantityType": "AMOUNT",
          "taxAmount": 0.1,
          "taxRate": 0.1,
          "total": 0.1,
          "totalWithTax": 0.1,
          "type": "ITEM",
          "unitPrice": 0.1
        }
      ],
      "salesOrderId": "string",
      "sentMails": [
        "string"
      ],
      "status": "DRAFT",
      "subsidiaryId": "string",
      "tenantId": "string",
      "total": 0.1,
      "totalExcludingTax": 0.1,
      "totalTax": 0.1,
      "totalWithTax": 0.1,
      "transactions": [
        {
          "accountId": "string",
          "amount": 0.1,
          "created": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "paymentMethod": "CREDIT_CARD",
          "tenantId": "string",
          "updated": "2019-08-24T14:15:22Z",
          "updatedBy": "string"
        }
      ],
      "type": "MANUAL",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Create a draft invoice

Authorization

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X POST "http://localhost:18080/api/v1/invoices/empty"

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contactEmail": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "datePaid": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "mailBody": "string",
  "milestoneId": "string",
  "note": "string",
  "opportunityId": "string",
  "overdueNotifiedAt": "2019-08-24T14:15:22Z",
  "paid": 0.1,
  "paidExcludingTax": 0.1,
  "paymentReference": "string",
  "paymentTermDays": 0,
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "recurringAgreement": {
    "autoSend": true,
    "endDate": "2019-08-24T14:15:22Z",
    "intervalDays": 0,
    "intervalMonths": 0,
    "nextInvoiceDate": "2019-08-24T14:15:22Z"
  },
  "reminderBody": "string",
  "reminders": [
    {
      "createdBy": "string",
      "sentOn": "2019-08-24T14:15:22Z"
    }
  ],
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "quantityType": "AMOUNT",
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "salesOrderId": "string",
  "sentMails": [
    "string"
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "total": 0.1,
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "transactions": [
    {
      "accountId": "string",
      "amount": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "paymentMethod": "CREDIT_CARD",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "type": "MANUAL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find by list of ids in current tenant

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

`application/json`

curl -X GET "http://localhost:18080/api/v1/invoices/find?ids=string"

[
  {
    "attachments": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "clientId": "string",
    "contactEmail": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currency": "string",
    "datePaid": "2019-08-24T14:15:22Z",
    "dueDate": "2019-08-24T14:15:22Z",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "invoiceDate": "2019-08-24T14:15:22Z",
    "invoiceNumber": "string",
    "mailBody": "string",
    "milestoneId": "string",
    "note": "string",
    "opportunityId": "string",
    "overdueNotifiedAt": "2019-08-24T14:15:22Z",
    "paid": 0.1,
    "paidExcludingTax": 0.1,
    "paymentReference": "string",
    "paymentTermDays": 0,
    "pdf": {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    },
    "recurringAgreement": {
      "autoSend": true,
      "endDate": "2019-08-24T14:15:22Z",
      "intervalDays": 0,
      "intervalMonths": 0,
      "nextInvoiceDate": "2019-08-24T14:15:22Z"
    },
    "reminderBody": "string",
    "reminders": [
      {
        "createdBy": "string",
        "sentOn": "2019-08-24T14:15:22Z"
      }
    ],
    "rows": [
      {
        "description": "string",
        "id": "string",
        "productId": "string",
        "quantity": 0.1,
        "quantityType": "AMOUNT",
        "taxAmount": 0.1,
        "taxRate": 0.1,
        "total": 0.1,
        "totalWithTax": 0.1,
        "type": "ITEM",
        "unitPrice": 0.1
      }
    ],
    "salesOrderId": "string",
    "sentMails": [
      "string"
    ],
    "status": "DRAFT",
    "subsidiaryId": "string",
    "tenantId": "string",
    "total": 0.1,
    "totalExcludingTax": 0.1,
    "totalTax": 0.1,
    "totalWithTax": 0.1,
    "transactions": [
      {
        "accountId": "string",
        "amount": 0.1,
        "created": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "paymentMethod": "CREDIT_CARD",
        "tenantId": "string",
        "updated": "2019-08-24T14:15:22Z",
        "updatedBy": "string"
      }
    ],
    "type": "MANUAL",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find all for current tenant

Authorization

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "http://localhost:18080/api/v1/invoices/find-all"

[
  {
    "attachments": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "clientId": "string",
    "contactEmail": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currency": "string",
    "datePaid": "2019-08-24T14:15:22Z",
    "dueDate": "2019-08-24T14:15:22Z",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "invoiceDate": "2019-08-24T14:15:22Z",
    "invoiceNumber": "string",
    "mailBody": "string",
    "milestoneId": "string",
    "note": "string",
    "opportunityId": "string",
    "overdueNotifiedAt": "2019-08-24T14:15:22Z",
    "paid": 0.1,
    "paidExcludingTax": 0.1,
    "paymentReference": "string",
    "paymentTermDays": 0,
    "pdf": {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    },
    "recurringAgreement": {
      "autoSend": true,
      "endDate": "2019-08-24T14:15:22Z",
      "intervalDays": 0,
      "intervalMonths": 0,
      "nextInvoiceDate": "2019-08-24T14:15:22Z"
    },
    "reminderBody": "string",
    "reminders": [
      {
        "createdBy": "string",
        "sentOn": "2019-08-24T14:15:22Z"
      }
    ],
    "rows": [
      {
        "description": "string",
        "id": "string",
        "productId": "string",
        "quantity": 0.1,
        "quantityType": "AMOUNT",
        "taxAmount": 0.1,
        "taxRate": 0.1,
        "total": 0.1,
        "totalWithTax": 0.1,
        "type": "ITEM",
        "unitPrice": 0.1
      }
    ],
    "salesOrderId": "string",
    "sentMails": [
      "string"
    ],
    "status": "DRAFT",
    "subsidiaryId": "string",
    "tenantId": "string",
    "total": 0.1,
    "totalExcludingTax": 0.1,
    "totalTax": 0.1,
    "totalWithTax": 0.1,
    "transactions": [
      {
        "accountId": "string",
        "amount": 0.1,
        "created": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "paymentMethod": "CREDIT_CARD",
        "tenantId": "string",
        "updated": "2019-08-24T14:15:22Z",
        "updatedBy": "string"
      }
    ],
    "type": "MANUAL",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find a list of entities by their IDs

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids?array<>

Response Body

`application/json`

curl -X GET "http://localhost:18080/api/v1/invoices/find-list"

[
  {
    "attachments": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "clientId": "string",
    "contactEmail": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currency": "string",
    "datePaid": "2019-08-24T14:15:22Z",
    "dueDate": "2019-08-24T14:15:22Z",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "invoiceDate": "2019-08-24T14:15:22Z",
    "invoiceNumber": "string",
    "mailBody": "string",
    "milestoneId": "string",
    "note": "string",
    "opportunityId": "string",
    "overdueNotifiedAt": "2019-08-24T14:15:22Z",
    "paid": 0.1,
    "paidExcludingTax": 0.1,
    "paymentReference": "string",
    "paymentTermDays": 0,
    "pdf": {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    },
    "recurringAgreement": {
      "autoSend": true,
      "endDate": "2019-08-24T14:15:22Z",
      "intervalDays": 0,
      "intervalMonths": 0,
      "nextInvoiceDate": "2019-08-24T14:15:22Z"
    },
    "reminderBody": "string",
    "reminders": [
      {
        "createdBy": "string",
        "sentOn": "2019-08-24T14:15:22Z"
      }
    ],
    "rows": [
      {
        "description": "string",
        "id": "string",
        "productId": "string",
        "quantity": 0.1,
        "quantityType": "AMOUNT",
        "taxAmount": 0.1,
        "taxRate": 0.1,
        "total": 0.1,
        "totalWithTax": 0.1,
        "type": "ITEM",
        "unitPrice": 0.1
      }
    ],
    "salesOrderId": "string",
    "sentMails": [
      "string"
    ],
    "status": "DRAFT",
    "subsidiaryId": "string",
    "tenantId": "string",
    "total": 0.1,
    "totalExcludingTax": 0.1,
    "totalTax": 0.1,
    "totalWithTax": 0.1,
    "transactions": [
      {
        "accountId": "string",
        "amount": 0.1,
        "created": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "paymentMethod": "CREDIT_CARD",
        "tenantId": "string",
        "updated": "2019-08-24T14:15:22Z",
        "updatedBy": "string"
      }
    ],
    "type": "MANUAL",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find by id in current tenant

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X GET "http://localhost:18080/api/v1/invoices/find/string"

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contactEmail": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "datePaid": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "mailBody": "string",
  "milestoneId": "string",
  "note": "string",
  "opportunityId": "string",
  "overdueNotifiedAt": "2019-08-24T14:15:22Z",
  "paid": 0.1,
  "paidExcludingTax": 0.1,
  "paymentReference": "string",
  "paymentTermDays": 0,
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "recurringAgreement": {
    "autoSend": true,
    "endDate": "2019-08-24T14:15:22Z",
    "intervalDays": 0,
    "intervalMonths": 0,
    "nextInvoiceDate": "2019-08-24T14:15:22Z"
  },
  "reminderBody": "string",
  "reminders": [
    {
      "createdBy": "string",
      "sentOn": "2019-08-24T14:15:22Z"
    }
  ],
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "quantityType": "AMOUNT",
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "salesOrderId": "string",
  "sentMails": [
    "string"
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "total": 0.1,
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "transactions": [
    {
      "accountId": "string",
      "amount": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "paymentMethod": "CREDIT_CARD",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "type": "MANUAL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get page by page number and size with optional sorting based on field to sortBy and direction

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

pageNumber?integer

Formatint32

pageSize?integer

Formatint32

sortBy?string

direction?string

Value in"ASC" | "DESC"

search?string

Response Body

`application/json`

curl -X GET "http://localhost:18080/api/v1/invoices/page"

{
  "content": [
    {
      "attachments": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "clientId": "string",
      "contactEmail": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "currency": "string",
      "datePaid": "2019-08-24T14:15:22Z",
      "dueDate": "2019-08-24T14:15:22Z",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "invoiceDate": "2019-08-24T14:15:22Z",
      "invoiceNumber": "string",
      "mailBody": "string",
      "milestoneId": "string",
      "note": "string",
      "opportunityId": "string",
      "overdueNotifiedAt": "2019-08-24T14:15:22Z",
      "paid": 0.1,
      "paidExcludingTax": 0.1,
      "paymentReference": "string",
      "paymentTermDays": 0,
      "pdf": {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      },
      "recurringAgreement": {
        "autoSend": true,
        "endDate": "2019-08-24T14:15:22Z",
        "intervalDays": 0,
        "intervalMonths": 0,
        "nextInvoiceDate": "2019-08-24T14:15:22Z"
      },
      "reminderBody": "string",
      "reminders": [
        {
          "createdBy": "string",
          "sentOn": "2019-08-24T14:15:22Z"
        }
      ],
      "rows": [
        {
          "description": "string",
          "id": "string",
          "productId": "string",
          "quantity": 0.1,
          "quantityType": "AMOUNT",
          "taxAmount": 0.1,
          "taxRate": 0.1,
          "total": 0.1,
          "totalWithTax": 0.1,
          "type": "ITEM",
          "unitPrice": 0.1
        }
      ],
      "salesOrderId": "string",
      "sentMails": [
        "string"
      ],
      "status": "DRAFT",
      "subsidiaryId": "string",
      "tenantId": "string",
      "total": 0.1,
      "totalExcludingTax": 0.1,
      "totalTax": 0.1,
      "totalWithTax": 0.1,
      "transactions": [
        {
          "accountId": "string",
          "amount": 0.1,
          "created": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "paymentMethod": "CREDIT_CARD",
          "tenantId": "string",
          "updated": "2019-08-24T14:15:22Z",
          "updatedBy": "string"
        }
      ],
      "type": "MANUAL",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get invoice statistics

Authorization

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "http://localhost:18080/api/v1/invoices/stats"

{
  "countByStatus": {
    "property1": 0,
    "property2": 0
  },
  "totalInvoiced": 0.1,
  "totalOutstanding": 0.1,
  "totalOverdue": 0.1,
  "totalPaid": 0.1
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

List invoices that have a recurring agreement configured

Authorization

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "http://localhost:18080/api/v1/invoices/with-recurring-drafts"

[
  {
    "attachments": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "clientId": "string",
    "contactEmail": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currency": "string",
    "datePaid": "2019-08-24T14:15:22Z",
    "dueDate": "2019-08-24T14:15:22Z",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "invoiceDate": "2019-08-24T14:15:22Z",
    "invoiceNumber": "string",
    "mailBody": "string",
    "milestoneId": "string",
    "note": "string",
    "opportunityId": "string",
    "overdueNotifiedAt": "2019-08-24T14:15:22Z",
    "paid": 0.1,
    "paidExcludingTax": 0.1,
    "paymentReference": "string",
    "paymentTermDays": 0,
    "pdf": {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    },
    "recurringAgreement": {
      "autoSend": true,
      "endDate": "2019-08-24T14:15:22Z",
      "intervalDays": 0,
      "intervalMonths": 0,
      "nextInvoiceDate": "2019-08-24T14:15:22Z"
    },
    "reminderBody": "string",
    "reminders": [
      {
        "createdBy": "string",
        "sentOn": "2019-08-24T14:15:22Z"
      }
    ],
    "rows": [
      {
        "description": "string",
        "id": "string",
        "productId": "string",
        "quantity": 0.1,
        "quantityType": "AMOUNT",
        "taxAmount": 0.1,
        "taxRate": 0.1,
        "total": 0.1,
        "totalWithTax": 0.1,
        "type": "ITEM",
        "unitPrice": 0.1
      }
    ],
    "salesOrderId": "string",
    "sentMails": [
      "string"
    ],
    "status": "DRAFT",
    "subsidiaryId": "string",
    "tenantId": "string",
    "total": 0.1,
    "totalExcludingTax": 0.1,
    "totalTax": 0.1,
    "totalWithTax": 0.1,
    "transactions": [
      {
        "accountId": "string",
        "amount": 0.1,
        "created": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "paymentMethod": "CREDIT_CARD",
        "tenantId": "string",
        "updated": "2019-08-24T14:15:22Z",
        "updatedBy": "string"
      }
    ],
    "type": "MANUAL",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Delete by id in current tenant

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

`application/json`

curl -X DELETE "http://localhost:18080/api/v1/invoices/string"

Empty

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Add a comment to an entity

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

body*string

Response Body

`application/json`

curl -X POST "http://localhost:18080/api/v1/invoices/string/comment" \  -H "Content-Type: application/json" \  -d 'string'

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contactEmail": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "datePaid": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "mailBody": "string",
  "milestoneId": "string",
  "note": "string",
  "opportunityId": "string",
  "overdueNotifiedAt": "2019-08-24T14:15:22Z",
  "paid": 0.1,
  "paidExcludingTax": 0.1,
  "paymentReference": "string",
  "paymentTermDays": 0,
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "recurringAgreement": {
    "autoSend": true,
    "endDate": "2019-08-24T14:15:22Z",
    "intervalDays": 0,
    "intervalMonths": 0,
    "nextInvoiceDate": "2019-08-24T14:15:22Z"
  },
  "reminderBody": "string",
  "reminders": [
    {
      "createdBy": "string",
      "sentOn": "2019-08-24T14:15:22Z"
    }
  ],
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "quantityType": "AMOUNT",
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "salesOrderId": "string",
  "sentMails": [
    "string"
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "total": 0.1,
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "transactions": [
    {
      "accountId": "string",
      "amount": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "paymentMethod": "CREDIT_CARD",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "type": "MANUAL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Adds a payment to an invoice

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

invoiceId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount*number

Formatdouble

date*string

Formatdate-time

description?string

paymentMethod*string

Value in"CREDIT_CARD" | "PAYPAL" | "BANK_TRANSFER" | "CASH"

Response Body

`application/json`

curl -X PATCH "http://localhost:18080/api/v1/invoices/string/add-payment" \  -H "Content-Type: application/json" \  -d '{    "amount": 0.1,    "date": "2019-08-24T14:15:22Z",    "paymentMethod": "CREDIT_CARD"  }'

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contactEmail": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "datePaid": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "mailBody": "string",
  "milestoneId": "string",
  "note": "string",
  "opportunityId": "string",
  "overdueNotifiedAt": "2019-08-24T14:15:22Z",
  "paid": 0.1,
  "paidExcludingTax": 0.1,
  "paymentReference": "string",
  "paymentTermDays": 0,
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "recurringAgreement": {
    "autoSend": true,
    "endDate": "2019-08-24T14:15:22Z",
    "intervalDays": 0,
    "intervalMonths": 0,
    "nextInvoiceDate": "2019-08-24T14:15:22Z"
  },
  "reminderBody": "string",
  "reminders": [
    {
      "createdBy": "string",
      "sentOn": "2019-08-24T14:15:22Z"
    }
  ],
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "quantityType": "AMOUNT",
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "salesOrderId": "string",
  "sentMails": [
    "string"
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "total": 0.1,
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "transactions": [
    {
      "accountId": "string",
      "amount": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "paymentMethod": "CREDIT_CARD",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "type": "MANUAL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Delete an attachment from an invoice

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

invoiceId*string

blobId*string

Response Body

`application/json`

curl -X DELETE "http://localhost:18080/api/v1/invoices/string/attachments/string"

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contactEmail": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "datePaid": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "mailBody": "string",
  "milestoneId": "string",
  "note": "string",
  "opportunityId": "string",
  "overdueNotifiedAt": "2019-08-24T14:15:22Z",
  "paid": 0.1,
  "paidExcludingTax": 0.1,
  "paymentReference": "string",
  "paymentTermDays": 0,
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "recurringAgreement": {
    "autoSend": true,
    "endDate": "2019-08-24T14:15:22Z",
    "intervalDays": 0,
    "intervalMonths": 0,
    "nextInvoiceDate": "2019-08-24T14:15:22Z"
  },
  "reminderBody": "string",
  "reminders": [
    {
      "createdBy": "string",
      "sentOn": "2019-08-24T14:15:22Z"
    }
  ],
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "quantityType": "AMOUNT",
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "salesOrderId": "string",
  "sentMails": [
    "string"
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "total": 0.1,
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "transactions": [
    {
      "accountId": "string",
      "amount": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "paymentMethod": "CREDIT_CARD",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "type": "MANUAL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Cancel an invoice

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

invoiceId*string

Response Body

`application/json`

curl -X PATCH "http://localhost:18080/api/v1/invoices/string/cancel"

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contactEmail": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "datePaid": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "mailBody": "string",
  "milestoneId": "string",
  "note": "string",
  "opportunityId": "string",
  "overdueNotifiedAt": "2019-08-24T14:15:22Z",
  "paid": 0.1,
  "paidExcludingTax": 0.1,
  "paymentReference": "string",
  "paymentTermDays": 0,
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "recurringAgreement": {
    "autoSend": true,
    "endDate": "2019-08-24T14:15:22Z",
    "intervalDays": 0,
    "intervalMonths": 0,
    "nextInvoiceDate": "2019-08-24T14:15:22Z"
  },
  "reminderBody": "string",
  "reminders": [
    {
      "createdBy": "string",
      "sentOn": "2019-08-24T14:15:22Z"
    }
  ],
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "quantityType": "AMOUNT",
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "salesOrderId": "string",
  "sentMails": [
    "string"
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "total": 0.1,
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "transactions": [
    {
      "accountId": "string",
      "amount": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "paymentMethod": "CREDIT_CARD",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "type": "MANUAL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Generate a PDF for an invoice (server-side)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

invoiceId*string

Response Body

`application/json`

curl -X POST "http://localhost:18080/api/v1/invoices/string/generate-pdf"

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contactEmail": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "datePaid": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "mailBody": "string",
  "milestoneId": "string",
  "note": "string",
  "opportunityId": "string",
  "overdueNotifiedAt": "2019-08-24T14:15:22Z",
  "paid": 0.1,
  "paidExcludingTax": 0.1,
  "paymentReference": "string",
  "paymentTermDays": 0,
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "recurringAgreement": {
    "autoSend": true,
    "endDate": "2019-08-24T14:15:22Z",
    "intervalDays": 0,
    "intervalMonths": 0,
    "nextInvoiceDate": "2019-08-24T14:15:22Z"
  },
  "reminderBody": "string",
  "reminders": [
    {
      "createdBy": "string",
      "sentOn": "2019-08-24T14:15:22Z"
    }
  ],
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "quantityType": "AMOUNT",
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "salesOrderId": "string",
  "sentMails": [
    "string"
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "total": 0.1,
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "transactions": [
    {
      "accountId": "string",
      "amount": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "paymentMethod": "CREDIT_CARD",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "type": "MANUAL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Link an invoice to an opportunity

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

invoiceId*string

opportunityId*string

Response Body

`application/json`

curl -X PATCH "http://localhost:18080/api/v1/invoices/string/link-opportunity/string"

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contactEmail": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "datePaid": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "mailBody": "string",
  "milestoneId": "string",
  "note": "string",
  "opportunityId": "string",
  "overdueNotifiedAt": "2019-08-24T14:15:22Z",
  "paid": 0.1,
  "paidExcludingTax": 0.1,
  "paymentReference": "string",
  "paymentTermDays": 0,
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "recurringAgreement": {
    "autoSend": true,
    "endDate": "2019-08-24T14:15:22Z",
    "intervalDays": 0,
    "intervalMonths": 0,
    "nextInvoiceDate": "2019-08-24T14:15:22Z"
  },
  "reminderBody": "string",
  "reminders": [
    {
      "createdBy": "string",
      "sentOn": "2019-08-24T14:15:22Z"
    }
  ],
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "quantityType": "AMOUNT",
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "salesOrderId": "string",
  "sentMails": [
    "string"
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "total": 0.1,
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "transactions": [
    {
      "accountId": "string",
      "amount": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "paymentMethod": "CREDIT_CARD",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "type": "MANUAL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Mark an invoice as paid

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

invoiceId*string

Query Parameters

date?string

Formatdate-time

Response Body

`application/json`

curl -X PATCH "http://localhost:18080/api/v1/invoices/string/mark-as-paid"

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contactEmail": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "datePaid": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "mailBody": "string",
  "milestoneId": "string",
  "note": "string",
  "opportunityId": "string",
  "overdueNotifiedAt": "2019-08-24T14:15:22Z",
  "paid": 0.1,
  "paidExcludingTax": 0.1,
  "paymentReference": "string",
  "paymentTermDays": 0,
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "recurringAgreement": {
    "autoSend": true,
    "endDate": "2019-08-24T14:15:22Z",
    "intervalDays": 0,
    "intervalMonths": 0,
    "nextInvoiceDate": "2019-08-24T14:15:22Z"
  },
  "reminderBody": "string",
  "reminders": [
    {
      "createdBy": "string",
      "sentOn": "2019-08-24T14:15:22Z"
    }
  ],
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "quantityType": "AMOUNT",
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "salesOrderId": "string",
  "sentMails": [
    "string"
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "total": 0.1,
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "transactions": [
    {
      "accountId": "string",
      "amount": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "paymentMethod": "CREDIT_CARD",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "type": "MANUAL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Mark an invoice as sent

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

invoiceId*string

Response Body

`application/json`

curl -X PATCH "http://localhost:18080/api/v1/invoices/string/mark-as-sent"

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contactEmail": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "datePaid": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "mailBody": "string",
  "milestoneId": "string",
  "note": "string",
  "opportunityId": "string",
  "overdueNotifiedAt": "2019-08-24T14:15:22Z",
  "paid": 0.1,
  "paidExcludingTax": 0.1,
  "paymentReference": "string",
  "paymentTermDays": 0,
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "recurringAgreement": {
    "autoSend": true,
    "endDate": "2019-08-24T14:15:22Z",
    "intervalDays": 0,
    "intervalMonths": 0,
    "nextInvoiceDate": "2019-08-24T14:15:22Z"
  },
  "reminderBody": "string",
  "reminders": [
    {
      "createdBy": "string",
      "sentOn": "2019-08-24T14:15:22Z"
    }
  ],
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "quantityType": "AMOUNT",
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "salesOrderId": "string",
  "sentMails": [
    "string"
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "total": 0.1,
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "transactions": [
    {
      "accountId": "string",
      "amount": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "paymentMethod": "CREDIT_CARD",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "type": "MANUAL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Add a new invoice row

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

invoiceId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

description?string

productId?string

quantity*number

Formatdouble

taxRate?number

Formatdouble

type*string

Value in"ITEM" | "DISCOUNT" | "CHAPTER"

unitPrice*number

Formatdouble

Response Body

`application/json`

curl -X POST "http://localhost:18080/api/v1/invoices/string/rows" \  -H "Content-Type: application/json" \  -d '{    "quantity": 0.1,    "type": "ITEM",    "unitPrice": 0.1  }'

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contactEmail": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "datePaid": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "mailBody": "string",
  "milestoneId": "string",
  "note": "string",
  "opportunityId": "string",
  "overdueNotifiedAt": "2019-08-24T14:15:22Z",
  "paid": 0.1,
  "paidExcludingTax": 0.1,
  "paymentReference": "string",
  "paymentTermDays": 0,
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "recurringAgreement": {
    "autoSend": true,
    "endDate": "2019-08-24T14:15:22Z",
    "intervalDays": 0,
    "intervalMonths": 0,
    "nextInvoiceDate": "2019-08-24T14:15:22Z"
  },
  "reminderBody": "string",
  "reminders": [
    {
      "createdBy": "string",
      "sentOn": "2019-08-24T14:15:22Z"
    }
  ],
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "quantityType": "AMOUNT",
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "salesOrderId": "string",
  "sentMails": [
    "string"
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "total": 0.1,
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "transactions": [
    {
      "accountId": "string",
      "amount": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "paymentMethod": "CREDIT_CARD",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "type": "MANUAL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Remove an invoice row

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

invoiceId*string

rowId*string

Response Body

`application/json`

curl -X DELETE "http://localhost:18080/api/v1/invoices/string/rows/string"

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contactEmail": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "datePaid": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "mailBody": "string",
  "milestoneId": "string",
  "note": "string",
  "opportunityId": "string",
  "overdueNotifiedAt": "2019-08-24T14:15:22Z",
  "paid": 0.1,
  "paidExcludingTax": 0.1,
  "paymentReference": "string",
  "paymentTermDays": 0,
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "recurringAgreement": {
    "autoSend": true,
    "endDate": "2019-08-24T14:15:22Z",
    "intervalDays": 0,
    "intervalMonths": 0,
    "nextInvoiceDate": "2019-08-24T14:15:22Z"
  },
  "reminderBody": "string",
  "reminders": [
    {
      "createdBy": "string",
      "sentOn": "2019-08-24T14:15:22Z"
    }
  ],
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "quantityType": "AMOUNT",
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "salesOrderId": "string",
  "sentMails": [
    "string"
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "total": 0.1,
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "transactions": [
    {
      "accountId": "string",
      "amount": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "paymentMethod": "CREDIT_CARD",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "type": "MANUAL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Schedule an invoice for future sending

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

invoiceId*string

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

pdf*file

Formatbinary

Response Body

`application/json`

curl -X POST "http://localhost:18080/api/v1/invoices/string/schedule" \  -F pdf="string"

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contactEmail": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "datePaid": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "mailBody": "string",
  "milestoneId": "string",
  "note": "string",
  "opportunityId": "string",
  "overdueNotifiedAt": "2019-08-24T14:15:22Z",
  "paid": 0.1,
  "paidExcludingTax": 0.1,
  "paymentReference": "string",
  "paymentTermDays": 0,
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "recurringAgreement": {
    "autoSend": true,
    "endDate": "2019-08-24T14:15:22Z",
    "intervalDays": 0,
    "intervalMonths": 0,
    "nextInvoiceDate": "2019-08-24T14:15:22Z"
  },
  "reminderBody": "string",
  "reminders": [
    {
      "createdBy": "string",
      "sentOn": "2019-08-24T14:15:22Z"
    }
  ],
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "quantityType": "AMOUNT",
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "salesOrderId": "string",
  "sentMails": [
    "string"
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "total": 0.1,
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "transactions": [
    {
      "accountId": "string",
      "amount": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "paymentMethod": "CREDIT_CARD",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "type": "MANUAL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Send an invoice via email

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

invoiceId*string

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

pdf*file

Formatbinary

Response Body

`application/json`

curl -X POST "http://localhost:18080/api/v1/invoices/string/send" \  -F pdf="string"

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contactEmail": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "datePaid": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "mailBody": "string",
  "milestoneId": "string",
  "note": "string",
  "opportunityId": "string",
  "overdueNotifiedAt": "2019-08-24T14:15:22Z",
  "paid": 0.1,
  "paidExcludingTax": 0.1,
  "paymentReference": "string",
  "paymentTermDays": 0,
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "recurringAgreement": {
    "autoSend": true,
    "endDate": "2019-08-24T14:15:22Z",
    "intervalDays": 0,
    "intervalMonths": 0,
    "nextInvoiceDate": "2019-08-24T14:15:22Z"
  },
  "reminderBody": "string",
  "reminders": [
    {
      "createdBy": "string",
      "sentOn": "2019-08-24T14:15:22Z"
    }
  ],
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "quantityType": "AMOUNT",
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "salesOrderId": "string",
  "sentMails": [
    "string"
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "total": 0.1,
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "transactions": [
    {
      "accountId": "string",
      "amount": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "paymentMethod": "CREDIT_CARD",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "type": "MANUAL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Send an invoice reminder email

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

invoiceId*string

Response Body

`application/json`

curl -X POST "http://localhost:18080/api/v1/invoices/string/send-reminder"

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contactEmail": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "datePaid": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "mailBody": "string",
  "milestoneId": "string",
  "note": "string",
  "opportunityId": "string",
  "overdueNotifiedAt": "2019-08-24T14:15:22Z",
  "paid": 0.1,
  "paidExcludingTax": 0.1,
  "paymentReference": "string",
  "paymentTermDays": 0,
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "recurringAgreement": {
    "autoSend": true,
    "endDate": "2019-08-24T14:15:22Z",
    "intervalDays": 0,
    "intervalMonths": 0,
    "nextInvoiceDate": "2019-08-24T14:15:22Z"
  },
  "reminderBody": "string",
  "reminders": [
    {
      "createdBy": "string",
      "sentOn": "2019-08-24T14:15:22Z"
    }
  ],
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "quantityType": "AMOUNT",
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "salesOrderId": "string",
  "sentMails": [
    "string"
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "total": 0.1,
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "transactions": [
    {
      "accountId": "string",
      "amount": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "paymentMethod": "CREDIT_CARD",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "type": "MANUAL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Unmark an invoice as paid

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

invoiceId*string

Response Body

`application/json`

curl -X PATCH "http://localhost:18080/api/v1/invoices/string/unmark-as-paid"

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contactEmail": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "datePaid": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "mailBody": "string",
  "milestoneId": "string",
  "note": "string",
  "opportunityId": "string",
  "overdueNotifiedAt": "2019-08-24T14:15:22Z",
  "paid": 0.1,
  "paidExcludingTax": 0.1,
  "paymentReference": "string",
  "paymentTermDays": 0,
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "recurringAgreement": {
    "autoSend": true,
    "endDate": "2019-08-24T14:15:22Z",
    "intervalDays": 0,
    "intervalMonths": 0,
    "nextInvoiceDate": "2019-08-24T14:15:22Z"
  },
  "reminderBody": "string",
  "reminders": [
    {
      "createdBy": "string",
      "sentOn": "2019-08-24T14:15:22Z"
    }
  ],
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "quantityType": "AMOUNT",
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "salesOrderId": "string",
  "sentMails": [
    "string"
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "total": 0.1,
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "transactions": [
    {
      "accountId": "string",
      "amount": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "paymentMethod": "CREDIT_CARD",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "type": "MANUAL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Unschedule a scheduled invoice back to draft

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

invoiceId*string

Response Body

`application/json`

curl -X PATCH "http://localhost:18080/api/v1/invoices/string/unschedule"

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contactEmail": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "datePaid": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "mailBody": "string",
  "milestoneId": "string",
  "note": "string",
  "opportunityId": "string",
  "overdueNotifiedAt": "2019-08-24T14:15:22Z",
  "paid": 0.1,
  "paidExcludingTax": 0.1,
  "paymentReference": "string",
  "paymentTermDays": 0,
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "recurringAgreement": {
    "autoSend": true,
    "endDate": "2019-08-24T14:15:22Z",
    "intervalDays": 0,
    "intervalMonths": 0,
    "nextInvoiceDate": "2019-08-24T14:15:22Z"
  },
  "reminderBody": "string",
  "reminders": [
    {
      "createdBy": "string",
      "sentOn": "2019-08-24T14:15:22Z"
    }
  ],
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "quantityType": "AMOUNT",
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "salesOrderId": "string",
  "sentMails": [
    "string"
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "total": 0.1,
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "transactions": [
    {
      "accountId": "string",
      "amount": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "paymentMethod": "CREDIT_CARD",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "type": "MANUAL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Update an existing invoice

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

invoiceId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

clientId?string

contactEmail?string

currency*string

invoiceDate*string

Formatdate-time

mailBody?string

note?string

opportunityId?string

paymentReference?string

paymentTermDays*integer

Formatint32

recurringAutoSend?boolean

recurringEndDate?string

Formatdate-time

recurringIntervalDays?integer

Formatint32

recurringIntervalMonths?integer

Formatint32

recurringNextInvoiceDate?string

Formatdate-time

reminderBody?string

rows*array<>

subsidiaryId?string

Response Body

`application/json`

curl -X PATCH "http://localhost:18080/api/v1/invoices/string/update" \  -H "Content-Type: application/json" \  -d '{    "currency": "string",    "invoiceDate": "2019-08-24T14:15:22Z",    "paymentTermDays": 0,    "rows": [      {        "id": "string",        "quantity": 0.1,        "quantityType": "AMOUNT",        "taxAmount": 0.1,        "total": 0.1,        "totalWithTax": 0.1,        "type": "ITEM",        "unitPrice": 0.1      }    ]  }'

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contactEmail": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "datePaid": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "mailBody": "string",
  "milestoneId": "string",
  "note": "string",
  "opportunityId": "string",
  "overdueNotifiedAt": "2019-08-24T14:15:22Z",
  "paid": 0.1,
  "paidExcludingTax": 0.1,
  "paymentReference": "string",
  "paymentTermDays": 0,
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "recurringAgreement": {
    "autoSend": true,
    "endDate": "2019-08-24T14:15:22Z",
    "intervalDays": 0,
    "intervalMonths": 0,
    "nextInvoiceDate": "2019-08-24T14:15:22Z"
  },
  "reminderBody": "string",
  "reminders": [
    {
      "createdBy": "string",
      "sentOn": "2019-08-24T14:15:22Z"
    }
  ],
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "quantityType": "AMOUNT",
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "salesOrderId": "string",
  "sentMails": [
    "string"
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "total": 0.1,
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "transactions": [
    {
      "accountId": "string",
      "amount": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "paymentMethod": "CREDIT_CARD",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "type": "MANUAL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Upload attachments to an invoice

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

invoiceId*string

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

files*array<>

Response Body

`application/json`

curl -X POST "http://localhost:18080/api/v1/invoices/string/upload-attachments" \  -F files="[\n  \"string\"\n]"

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contactEmail": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "datePaid": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "mailBody": "string",
  "milestoneId": "string",
  "note": "string",
  "opportunityId": "string",
  "overdueNotifiedAt": "2019-08-24T14:15:22Z",
  "paid": 0.1,
  "paidExcludingTax": 0.1,
  "paymentReference": "string",
  "paymentTermDays": 0,
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "recurringAgreement": {
    "autoSend": true,
    "endDate": "2019-08-24T14:15:22Z",
    "intervalDays": 0,
    "intervalMonths": 0,
    "nextInvoiceDate": "2019-08-24T14:15:22Z"
  },
  "reminderBody": "string",
  "reminders": [
    {
      "createdBy": "string",
      "sentOn": "2019-08-24T14:15:22Z"
    }
  ],
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "quantityType": "AMOUNT",
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "salesOrderId": "string",
  "sentMails": [
    "string"
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "total": 0.1,
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "transactions": [
    {
      "accountId": "string",
      "amount": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "paymentMethod": "CREDIT_CARD",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "type": "MANUAL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Adds a payment to an invoice

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

invoiceId*string

transactionId*string

Response Body

`application/json`

curl -X DELETE "http://localhost:18080/api/v1/invoices/string/string/remove-payment"

Empty

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Invoice

200application/json

400application/json

403application/json

500application/json

200application/json

400application/json

403application/json

500application/json

200application/json

400application/json

403application/json

500application/json

200application/json

400application/json

403application/json

500application/json

200application/json

400application/json

403application/json

500application/json

204

400application/json

403application/json

500application/json

200application/json

400application/json

403application/json

500application/json

200application/json

400application/json

403application/json

500application/json

200application/json

400application/json

403application/json

500application/json

200application/json

400application/json

403application/json

500application/json

200application/json

400application/json

403application/json

500application/json

200application/json

400application/json

403application/json

500application/json

200application/json

400application/json

403application/json

500application/json

200application/json

400application/json

403application/json

500application/json

200application/json

400application/json

403application/json

500application/json

200application/json

400application/json

403application/json

500application/json

204

400application/json

403application/json

500application/json

200application/json

400application/json

403application/json

500application/json

200application/json

400application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`