AlphaAlpha Docs
API Reference

Debit Notes

Debit Note Management API

Delete multiple debit notes

DELETE
/debit-notes/batch

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/debit-notes/batch?ids=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"
}

Get debit notes for a purchase order

GET
/debit-notes/by-po/{poId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

poId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/debit-notes/by-po/string"
[
  {
    "clearingEntries": [
      {
        "clearingStockSiteId": "string",
        "productId": "string",
        "quantity": 0.1
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currency": "string",
    "dueDate": "2019-08-24T14:15:22Z",
    "id": "string",
    "issueDate": "2019-08-24T14:15:22Z",
    "note": "string",
    "purchaseOrderId": "string",
    "referenceNumber": "string",
    "rows": [
      {
        "description": "string",
        "glAccountId": "string",
        "id": "string",
        "productId": "string",
        "productName": "string",
        "quantity": 0.1,
        "taxAmount": 0.1,
        "taxRate": 0.1,
        "total": 0.1,
        "totalWithTax": 0.1,
        "unitPrice": 0.1
      }
    ],
    "settledDate": "2019-08-24T14:15:22Z",
    "status": "string",
    "subsidiaryId": "string",
    "subtotal": 0.1,
    "supplierEmail": "string",
    "supplierId": "string",
    "supplierName": "string",
    "taxAmount": 0.1,
    "totalAmount": 0.1,
    "updated": "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"
}

Download Csv_ Debit Note

GET
/debit-notes/csv-export

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

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/debit-notes/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"
}

Delete a list of entities by their IDs

DELETE
/debit-notes/delete-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/debit-notes/delete-list?ids=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"
}

Dynamic Search_ Debit Note

GET
/debit-notes/dynamic-search

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

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/debit-notes/dynamic-search"
{
  "content": [
    {
      "attachments": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "clearingEntries": [
        {
          "clearingStockSiteId": "string",
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "currency": "string",
      "dueDate": "2019-08-24T14:15:22Z",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "issueDate": "2019-08-24T14:15:22Z",
      "mailBody": "string",
      "note": "string",
      "pdf": {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      },
      "purchaseOrderId": "string",
      "referenceNumber": "string",
      "rows": [
        {
          "description": "string",
          "glAccountId": "string",
          "id": "string",
          "productId": "string",
          "quantity": 0.1,
          "taxAmount": 0.1,
          "taxRate": 0.1,
          "total": 0.1,
          "totalWithTax": 0.1,
          "unitPrice": 0.1
        }
      ],
      "sentMails": [
        "string"
      ],
      "settledDate": "2019-08-24T14:15:22Z",
      "status": "DRAFT",
      "subsidiaryId": "string",
      "subtotal": 0.1,
      "supplierEmail": "string",
      "supplierId": "string",
      "supplierName": "string",
      "taxAmount": 0.1,
      "tenantId": "string",
      "totalAmount": 0.1,
      "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_ Debit Note

POST
/debit-notes/dynamic-search

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/debit-notes/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"
        }
      ],
      "clearingEntries": [
        {
          "clearingStockSiteId": "string",
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "currency": "string",
      "dueDate": "2019-08-24T14:15:22Z",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "issueDate": "2019-08-24T14:15:22Z",
      "mailBody": "string",
      "note": "string",
      "pdf": {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      },
      "purchaseOrderId": "string",
      "referenceNumber": "string",
      "rows": [
        {
          "description": "string",
          "glAccountId": "string",
          "id": "string",
          "productId": "string",
          "quantity": 0.1,
          "taxAmount": 0.1,
          "taxRate": 0.1,
          "total": 0.1,
          "totalWithTax": 0.1,
          "unitPrice": 0.1
        }
      ],
      "sentMails": [
        "string"
      ],
      "settledDate": "2019-08-24T14:15:22Z",
      "status": "DRAFT",
      "subsidiaryId": "string",
      "subtotal": 0.1,
      "supplierEmail": "string",
      "supplierId": "string",
      "supplierName": "string",
      "taxAmount": 0.1,
      "tenantId": "string",
      "totalAmount": 0.1,
      "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 an empty draft debit note

POST
/debit-notes/empty

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/debit-notes/empty"
{
  "clearingEntries": [
    {
      "clearingStockSiteId": "string",
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "dueDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "issueDate": "2019-08-24T14:15:22Z",
  "note": "string",
  "purchaseOrderId": "string",
  "referenceNumber": "string",
  "rows": [
    {
      "description": "string",
      "glAccountId": "string",
      "id": "string",
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "unitPrice": 0.1
    }
  ],
  "settledDate": "2019-08-24T14:15:22Z",
  "status": "string",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "totalAmount": 0.1,
  "updated": "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"
}

Find by list of ids in current tenant

GET
/debit-notes/find

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/debit-notes/find?ids=string"
[
  {
    "attachments": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "clearingEntries": [
      {
        "clearingStockSiteId": "string",
        "productId": "string",
        "quantity": 0.1
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currency": "string",
    "dueDate": "2019-08-24T14:15:22Z",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "issueDate": "2019-08-24T14:15:22Z",
    "mailBody": "string",
    "note": "string",
    "pdf": {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    },
    "purchaseOrderId": "string",
    "referenceNumber": "string",
    "rows": [
      {
        "description": "string",
        "glAccountId": "string",
        "id": "string",
        "productId": "string",
        "quantity": 0.1,
        "taxAmount": 0.1,
        "taxRate": 0.1,
        "total": 0.1,
        "totalWithTax": 0.1,
        "unitPrice": 0.1
      }
    ],
    "sentMails": [
      "string"
    ],
    "settledDate": "2019-08-24T14:15:22Z",
    "status": "DRAFT",
    "subsidiaryId": "string",
    "subtotal": 0.1,
    "supplierEmail": "string",
    "supplierId": "string",
    "supplierName": "string",
    "taxAmount": 0.1,
    "tenantId": "string",
    "totalAmount": 0.1,
    "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

GET
/debit-notes/find-all

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/debit-notes/find-all"
[
  {
    "attachments": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "clearingEntries": [
      {
        "clearingStockSiteId": "string",
        "productId": "string",
        "quantity": 0.1
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currency": "string",
    "dueDate": "2019-08-24T14:15:22Z",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "issueDate": "2019-08-24T14:15:22Z",
    "mailBody": "string",
    "note": "string",
    "pdf": {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    },
    "purchaseOrderId": "string",
    "referenceNumber": "string",
    "rows": [
      {
        "description": "string",
        "glAccountId": "string",
        "id": "string",
        "productId": "string",
        "quantity": 0.1,
        "taxAmount": 0.1,
        "taxRate": 0.1,
        "total": 0.1,
        "totalWithTax": 0.1,
        "unitPrice": 0.1
      }
    ],
    "sentMails": [
      "string"
    ],
    "settledDate": "2019-08-24T14:15:22Z",
    "status": "DRAFT",
    "subsidiaryId": "string",
    "subtotal": 0.1,
    "supplierEmail": "string",
    "supplierId": "string",
    "supplierName": "string",
    "taxAmount": 0.1,
    "tenantId": "string",
    "totalAmount": 0.1,
    "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

GET
/debit-notes/find-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids?array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/debit-notes/find-list"
[
  {
    "attachments": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "clearingEntries": [
      {
        "clearingStockSiteId": "string",
        "productId": "string",
        "quantity": 0.1
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currency": "string",
    "dueDate": "2019-08-24T14:15:22Z",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "issueDate": "2019-08-24T14:15:22Z",
    "mailBody": "string",
    "note": "string",
    "pdf": {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    },
    "purchaseOrderId": "string",
    "referenceNumber": "string",
    "rows": [
      {
        "description": "string",
        "glAccountId": "string",
        "id": "string",
        "productId": "string",
        "quantity": 0.1,
        "taxAmount": 0.1,
        "taxRate": 0.1,
        "total": 0.1,
        "totalWithTax": 0.1,
        "unitPrice": 0.1
      }
    ],
    "sentMails": [
      "string"
    ],
    "settledDate": "2019-08-24T14:15:22Z",
    "status": "DRAFT",
    "subsidiaryId": "string",
    "subtotal": 0.1,
    "supplierEmail": "string",
    "supplierId": "string",
    "supplierName": "string",
    "taxAmount": 0.1,
    "tenantId": "string",
    "totalAmount": 0.1,
    "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

GET
/debit-notes/find/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/debit-notes/find/string"
{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clearingEntries": [
    {
      "clearingStockSiteId": "string",
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "dueDate": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "issueDate": "2019-08-24T14:15:22Z",
  "mailBody": "string",
  "note": "string",
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "purchaseOrderId": "string",
  "referenceNumber": "string",
  "rows": [
    {
      "description": "string",
      "glAccountId": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "unitPrice": 0.1
    }
  ],
  "sentMails": [
    "string"
  ],
  "settledDate": "2019-08-24T14:15:22Z",
  "status": "DRAFT",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "tenantId": "string",
  "totalAmount": 0.1,
  "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"
}

Create a debit note from purchase order shortages

POST
/debit-notes/from-po/{poId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

poId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/debit-notes/from-po/string" \  -H "Content-Type: application/json" \  -d '{    "items": [      {        "productId": "string",        "quantity": 0.1      }    ]  }'
{
  "clearingEntries": [
    {
      "clearingStockSiteId": "string",
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "dueDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "issueDate": "2019-08-24T14:15:22Z",
  "note": "string",
  "purchaseOrderId": "string",
  "referenceNumber": "string",
  "rows": [
    {
      "description": "string",
      "glAccountId": "string",
      "id": "string",
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "unitPrice": 0.1
    }
  ],
  "settledDate": "2019-08-24T14:15:22Z",
  "status": "string",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "totalAmount": 0.1,
  "updated": "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"
}

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

GET
/debit-notes/page

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

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/debit-notes/page"
{
  "content": [
    {
      "attachments": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "clearingEntries": [
        {
          "clearingStockSiteId": "string",
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "currency": "string",
      "dueDate": "2019-08-24T14:15:22Z",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "issueDate": "2019-08-24T14:15:22Z",
      "mailBody": "string",
      "note": "string",
      "pdf": {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      },
      "purchaseOrderId": "string",
      "referenceNumber": "string",
      "rows": [
        {
          "description": "string",
          "glAccountId": "string",
          "id": "string",
          "productId": "string",
          "quantity": 0.1,
          "taxAmount": 0.1,
          "taxRate": 0.1,
          "total": 0.1,
          "totalWithTax": 0.1,
          "unitPrice": 0.1
        }
      ],
      "sentMails": [
        "string"
      ],
      "settledDate": "2019-08-24T14:15:22Z",
      "status": "DRAFT",
      "subsidiaryId": "string",
      "subtotal": 0.1,
      "supplierEmail": "string",
      "supplierId": "string",
      "supplierName": "string",
      "taxAmount": 0.1,
      "tenantId": "string",
      "totalAmount": 0.1,
      "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 paginated list of debit notes

GET
/debit-notes/page-enriched

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

pageable*
search?string
Default""

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/debit-notes/page-enriched?page=0&size=1&sort=string"
{
  "content": [
    {
      "clearingEntries": [
        {
          "clearingStockSiteId": "string",
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "currency": "string",
      "dueDate": "2019-08-24T14:15:22Z",
      "id": "string",
      "issueDate": "2019-08-24T14:15:22Z",
      "note": "string",
      "purchaseOrderId": "string",
      "referenceNumber": "string",
      "rows": [
        {
          "description": "string",
          "glAccountId": "string",
          "id": "string",
          "productId": "string",
          "productName": "string",
          "quantity": 0.1,
          "taxAmount": 0.1,
          "taxRate": 0.1,
          "total": 0.1,
          "totalWithTax": 0.1,
          "unitPrice": 0.1
        }
      ],
      "settledDate": "2019-08-24T14:15:22Z",
      "status": "string",
      "subsidiaryId": "string",
      "subtotal": 0.1,
      "supplierEmail": "string",
      "supplierId": "string",
      "supplierName": "string",
      "taxAmount": 0.1,
      "totalAmount": 0.1,
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "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"
}

Update a draft debit note

PATCH
/debit-notes/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/debit-notes/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "clearingEntries": [
    {
      "clearingStockSiteId": "string",
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "dueDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "issueDate": "2019-08-24T14:15:22Z",
  "note": "string",
  "purchaseOrderId": "string",
  "referenceNumber": "string",
  "rows": [
    {
      "description": "string",
      "glAccountId": "string",
      "id": "string",
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "unitPrice": 0.1
    }
  ],
  "settledDate": "2019-08-24T14:15:22Z",
  "status": "string",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "totalAmount": 0.1,
  "updated": "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 by id in current tenant

DELETE
/debit-notes/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/debit-notes/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"
}

Mark debit note as acknowledged

PATCH
/debit-notes/{id}/acknowledge

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/debit-notes/string/acknowledge"
{
  "clearingEntries": [
    {
      "clearingStockSiteId": "string",
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "dueDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "issueDate": "2019-08-24T14:15:22Z",
  "note": "string",
  "purchaseOrderId": "string",
  "referenceNumber": "string",
  "rows": [
    {
      "description": "string",
      "glAccountId": "string",
      "id": "string",
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "unitPrice": 0.1
    }
  ],
  "settledDate": "2019-08-24T14:15:22Z",
  "status": "string",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "totalAmount": 0.1,
  "updated": "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"
}

Cancel a debit note

PATCH
/debit-notes/{id}/cancel

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/debit-notes/string/cancel"
{
  "clearingEntries": [
    {
      "clearingStockSiteId": "string",
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "dueDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "issueDate": "2019-08-24T14:15:22Z",
  "note": "string",
  "purchaseOrderId": "string",
  "referenceNumber": "string",
  "rows": [
    {
      "description": "string",
      "glAccountId": "string",
      "id": "string",
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "unitPrice": 0.1
    }
  ],
  "settledDate": "2019-08-24T14:15:22Z",
  "status": "string",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "totalAmount": 0.1,
  "updated": "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"
}

Add a comment to an entity

POST
/debit-notes/{id}/comment

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

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/debit-notes/string/comment" \  -H "Content-Type: application/json" \  -d '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 a debit note with enriched data

GET
/debit-notes/{id}/enriched

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/debit-notes/string/enriched"
{
  "clearingEntries": [
    {
      "clearingStockSiteId": "string",
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "dueDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "issueDate": "2019-08-24T14:15:22Z",
  "note": "string",
  "purchaseOrderId": "string",
  "referenceNumber": "string",
  "rows": [
    {
      "description": "string",
      "glAccountId": "string",
      "id": "string",
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "unitPrice": 0.1
    }
  ],
  "settledDate": "2019-08-24T14:15:22Z",
  "status": "string",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "totalAmount": 0.1,
  "updated": "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"
}

Add a row to a debit note

POST
/debit-notes/{id}/rows

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/debit-notes/string/rows" \  -H "Content-Type: application/json" \  -d '{    "quantity": 0.1,    "unitPrice": 0.1  }'
{
  "clearingEntries": [
    {
      "clearingStockSiteId": "string",
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "dueDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "issueDate": "2019-08-24T14:15:22Z",
  "note": "string",
  "purchaseOrderId": "string",
  "referenceNumber": "string",
  "rows": [
    {
      "description": "string",
      "glAccountId": "string",
      "id": "string",
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "unitPrice": 0.1
    }
  ],
  "settledDate": "2019-08-24T14:15:22Z",
  "status": "string",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "totalAmount": 0.1,
  "updated": "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"
}

Remove a row from a debit note

DELETE
/debit-notes/{id}/rows/{rowId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string
rowId*string

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/debit-notes/string/rows/string"
{
  "clearingEntries": [
    {
      "clearingStockSiteId": "string",
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "dueDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "issueDate": "2019-08-24T14:15:22Z",
  "note": "string",
  "purchaseOrderId": "string",
  "referenceNumber": "string",
  "rows": [
    {
      "description": "string",
      "glAccountId": "string",
      "id": "string",
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "unitPrice": 0.1
    }
  ],
  "settledDate": "2019-08-24T14:15:22Z",
  "status": "string",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "totalAmount": 0.1,
  "updated": "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"
}

Update a row on a debit note

PUT
/debit-notes/{id}/rows/{rowId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string
rowId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PUT "http://localhost:18080/api/v1/debit-notes/string/rows/string" \  -H "Content-Type: application/json" \  -d '{    "quantity": 0.1,    "unitPrice": 0.1  }'
{
  "clearingEntries": [
    {
      "clearingStockSiteId": "string",
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "dueDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "issueDate": "2019-08-24T14:15:22Z",
  "note": "string",
  "purchaseOrderId": "string",
  "referenceNumber": "string",
  "rows": [
    {
      "description": "string",
      "glAccountId": "string",
      "id": "string",
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "unitPrice": 0.1
    }
  ],
  "settledDate": "2019-08-24T14:15:22Z",
  "status": "string",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "totalAmount": 0.1,
  "updated": "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"
}

Send debit note to supplier

PATCH
/debit-notes/{id}/send

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/debit-notes/string/send"
{
  "clearingEntries": [
    {
      "clearingStockSiteId": "string",
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "dueDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "issueDate": "2019-08-24T14:15:22Z",
  "note": "string",
  "purchaseOrderId": "string",
  "referenceNumber": "string",
  "rows": [
    {
      "description": "string",
      "glAccountId": "string",
      "id": "string",
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "unitPrice": 0.1
    }
  ],
  "settledDate": "2019-08-24T14:15:22Z",
  "status": "string",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "totalAmount": 0.1,
  "updated": "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"
}

Settle debit note (resolve clearing)

PATCH
/debit-notes/{id}/settle

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/debit-notes/string/settle"
{
  "clearingEntries": [
    {
      "clearingStockSiteId": "string",
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "dueDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "issueDate": "2019-08-24T14:15:22Z",
  "note": "string",
  "purchaseOrderId": "string",
  "referenceNumber": "string",
  "rows": [
    {
      "description": "string",
      "glAccountId": "string",
      "id": "string",
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "unitPrice": 0.1
    }
  ],
  "settledDate": "2019-08-24T14:15:22Z",
  "status": "string",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "totalAmount": 0.1,
  "updated": "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"
}

Currency

Previous Page

Dynamic Search

How to use the dynamic search endpoints available on all CRUD resources.