A P Invoices

Accounts Payable Invoice Management API

Create a new AP invoice

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

classification?

currency*string

dueDate*string

Formatdate-time

invoiceDate*string

Formatdate-time

invoiceNumber?string

note?string

receivedDate?string

Formatdate-time

referenceNumber?string

rows*array<>

subsidiaryId*string

supplierId?string

Response Body

`application/json`

curl -X POST "http://localhost:18080/api/v1/ap-invoices" \  -H "Content-Type: application/json" \  -d '{    "currency": "string",    "dueDate": "2019-08-24T14:15:22Z",    "invoiceDate": "2019-08-24T14:15:22Z",    "rows": [      {        "quantity": 0.1,        "unitPrice": 0.1      }    ],    "subsidiaryId": "string"  }'

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "classification": {
    "category": "string",
    "costCenterId": "string",
    "glAccountId": "string",
    "projectId": "string",
    "subcategory": "string"
  },
  "classificationMethod": "MANUAL",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "daysOverdue": 0,
  "dueDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "isOverdue": true,
  "linkedPurchaseOrders": [
    {
      "allocatedAmount": 0.1,
      "costType": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "purchaseOrderId": "string",
      "purchaseOrderNumber": "string",
      "purchaseOrderStatus": "string",
      "purchaseOrderTotal": 0.1,
      "stockAdjustmentApplied": true
    }
  ],
  "note": "string",
  "outstandingAmount": 0.1,
  "paidAmount": 0.1,
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentStatus": "UNPAID",
  "payments": [
    {
      "amount": 0.1,
      "bankTransactionId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "id": "string",
      "note": "string",
      "paymentMethod": "BANK_TRANSFER",
      "reference": "string"
    }
  ],
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "receivedDate": "2019-08-24T14:15:22Z",
  "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
    }
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "tenantId": "string",
  "totalAmount": 0.1,
  "totalLinkedAmount": 0.1,
  "unlinkedAmount": 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"
}

Get AP invoice aging report

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

subsidiaryId?string

currency?string

Default"EUR"

Response Body

`application/json`

curl -X GET "http://localhost:18080/api/v1/ap-invoices/aging-report"

{
  "buckets": [
    {
      "bucket": "string",
      "count": 0,
      "totalAmount": 0.1
    }
  ],
  "currency": "string",
  "generatedAt": "2019-08-24T14:15:22Z",
  "totalOutstanding": 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"
}

Get AP invoices linked to a purchase order

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

purchaseOrderId*string

Response Body

`application/json`

curl -X GET "http://localhost:18080/api/v1/ap-invoices/by-purchase-order/string"

[
  {
    "attachments": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "classification": {
      "category": "string",
      "costCenterId": "string",
      "glAccountId": "string",
      "projectId": "string",
      "subcategory": "string"
    },
    "classificationMethod": "MANUAL",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currency": "string",
    "daysOverdue": 0,
    "dueDate": "2019-08-24T14:15:22Z",
    "id": "string",
    "invoiceDate": "2019-08-24T14:15:22Z",
    "invoiceNumber": "string",
    "isOverdue": true,
    "linkedPurchaseOrders": [
      {
        "allocatedAmount": 0.1,
        "costType": "string",
        "created": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "purchaseOrderId": "string",
        "purchaseOrderNumber": "string",
        "purchaseOrderStatus": "string",
        "purchaseOrderTotal": 0.1,
        "stockAdjustmentApplied": true
      }
    ],
    "note": "string",
    "outstandingAmount": 0.1,
    "paidAmount": 0.1,
    "paidDate": "2019-08-24T14:15:22Z",
    "paymentStatus": "UNPAID",
    "payments": [
      {
        "amount": 0.1,
        "bankTransactionId": "string",
        "created": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "date": "2019-08-24T14:15:22Z",
        "id": "string",
        "note": "string",
        "paymentMethod": "BANK_TRANSFER",
        "reference": "string"
      }
    ],
    "pdf": {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    },
    "receivedDate": "2019-08-24T14:15:22Z",
    "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
      }
    ],
    "status": "DRAFT",
    "subsidiaryId": "string",
    "subtotal": 0.1,
    "supplierEmail": "string",
    "supplierId": "string",
    "supplierName": "string",
    "taxAmount": 0.1,
    "tenantId": "string",
    "totalAmount": 0.1,
    "totalLinkedAmount": 0.1,
    "unlinkedAmount": 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"
}

Get AP invoices by supplier

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

supplierId*string

Query Parameters

pageable*

Response Body

`application/json`

curl -X GET "http://localhost:18080/api/v1/ap-invoices/by-supplier/string?page=0&size=1&sort=string"

{
  "content": [
    {
      "attachments": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "classification": {
        "category": "string",
        "costCenterId": "string",
        "glAccountId": "string",
        "projectId": "string",
        "subcategory": "string"
      },
      "classificationMethod": "MANUAL",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "currency": "string",
      "daysOverdue": 0,
      "dueDate": "2019-08-24T14:15:22Z",
      "id": "string",
      "invoiceDate": "2019-08-24T14:15:22Z",
      "invoiceNumber": "string",
      "isOverdue": true,
      "linkedPurchaseOrders": [
        {
          "allocatedAmount": 0.1,
          "costType": "string",
          "created": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "purchaseOrderId": "string",
          "purchaseOrderNumber": "string",
          "purchaseOrderStatus": "string",
          "purchaseOrderTotal": 0.1,
          "stockAdjustmentApplied": true
        }
      ],
      "note": "string",
      "outstandingAmount": 0.1,
      "paidAmount": 0.1,
      "paidDate": "2019-08-24T14:15:22Z",
      "paymentStatus": "UNPAID",
      "payments": [
        {
          "amount": 0.1,
          "bankTransactionId": "string",
          "created": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "date": "2019-08-24T14:15:22Z",
          "id": "string",
          "note": "string",
          "paymentMethod": "BANK_TRANSFER",
          "reference": "string"
        }
      ],
      "pdf": {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      },
      "receivedDate": "2019-08-24T14:15:22Z",
      "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
        }
      ],
      "status": "DRAFT",
      "subsidiaryId": "string",
      "subtotal": 0.1,
      "supplierEmail": "string",
      "supplierId": "string",
      "supplierName": "string",
      "taxAmount": 0.1,
      "tenantId": "string",
      "totalAmount": 0.1,
      "totalLinkedAmount": 0.1,
      "unlinkedAmount": 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"
}

Download Csv_ A P 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/ap-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"
}

Delete a list of AP 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/ap-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_ A P 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/ap-invoices/dynamic-search"

{
  "content": [
    {
      "attachments": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "classification": {
        "category": "string",
        "costCenterId": "string",
        "glAccountId": "string",
        "projectId": "string",
        "subcategory": "string"
      },
      "classificationMethod": "MANUAL",
      "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",
      "invoiceDate": "2019-08-24T14:15:22Z",
      "invoiceNumber": "string",
      "linkedPurchaseOrders": [
        {
          "allocatedAmount": 0.1,
          "costType": "PRODUCT",
          "created": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "purchaseOrderId": "string",
          "stockAdjustmentApplied": true
        }
      ],
      "note": "string",
      "outstandingAmount": 0.1,
      "paidAmount": 0.1,
      "paidDate": "2019-08-24T14:15:22Z",
      "paymentStatus": "UNPAID",
      "payments": [
        {
          "amount": 0.1,
          "bankTransactionId": "string",
          "created": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "date": "2019-08-24T14:15:22Z",
          "id": "string",
          "note": "string",
          "paymentMethod": "BANK_TRANSFER",
          "reference": "string"
        }
      ],
      "pdf": {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      },
      "receivedDate": "2019-08-24T14:15:22Z",
      "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
        }
      ],
      "status": "DRAFT",
      "subsidiaryId": "string",
      "subtotal": 0.1,
      "supplierId": "string",
      "supplierName": "string",
      "taxAmount": 0.1,
      "tenantId": "string",
      "totalAmount": 0.1,
      "totalLinkedAmount": 0.1,
      "unlinkedAmount": 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_ A P 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/ap-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"
        }
      ],
      "classification": {
        "category": "string",
        "costCenterId": "string",
        "glAccountId": "string",
        "projectId": "string",
        "subcategory": "string"
      },
      "classificationMethod": "MANUAL",
      "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",
      "invoiceDate": "2019-08-24T14:15:22Z",
      "invoiceNumber": "string",
      "linkedPurchaseOrders": [
        {
          "allocatedAmount": 0.1,
          "costType": "PRODUCT",
          "created": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "purchaseOrderId": "string",
          "stockAdjustmentApplied": true
        }
      ],
      "note": "string",
      "outstandingAmount": 0.1,
      "paidAmount": 0.1,
      "paidDate": "2019-08-24T14:15:22Z",
      "paymentStatus": "UNPAID",
      "payments": [
        {
          "amount": 0.1,
          "bankTransactionId": "string",
          "created": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "date": "2019-08-24T14:15:22Z",
          "id": "string",
          "note": "string",
          "paymentMethod": "BANK_TRANSFER",
          "reference": "string"
        }
      ],
      "pdf": {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      },
      "receivedDate": "2019-08-24T14:15:22Z",
      "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
        }
      ],
      "status": "DRAFT",
      "subsidiaryId": "string",
      "subtotal": 0.1,
      "supplierId": "string",
      "supplierName": "string",
      "taxAmount": 0.1,
      "tenantId": "string",
      "totalAmount": 0.1,
      "totalLinkedAmount": 0.1,
      "unlinkedAmount": 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 AP invoice

Authorization

AuthorizationBearer <token>

In: header

Response Body

`application/json`

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

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "classification": {
    "category": "string",
    "costCenterId": "string",
    "glAccountId": "string",
    "projectId": "string",
    "subcategory": "string"
  },
  "classificationMethod": "MANUAL",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "daysOverdue": 0,
  "dueDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "isOverdue": true,
  "linkedPurchaseOrders": [
    {
      "allocatedAmount": 0.1,
      "costType": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "purchaseOrderId": "string",
      "purchaseOrderNumber": "string",
      "purchaseOrderStatus": "string",
      "purchaseOrderTotal": 0.1,
      "stockAdjustmentApplied": true
    }
  ],
  "note": "string",
  "outstandingAmount": 0.1,
  "paidAmount": 0.1,
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentStatus": "UNPAID",
  "payments": [
    {
      "amount": 0.1,
      "bankTransactionId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "id": "string",
      "note": "string",
      "paymentMethod": "BANK_TRANSFER",
      "reference": "string"
    }
  ],
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "receivedDate": "2019-08-24T14:15:22Z",
  "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
    }
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "tenantId": "string",
  "totalAmount": 0.1,
  "totalLinkedAmount": 0.1,
  "unlinkedAmount": 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 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/ap-invoices/find?ids=string"

[
  {
    "attachments": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "classification": {
      "category": "string",
      "costCenterId": "string",
      "glAccountId": "string",
      "projectId": "string",
      "subcategory": "string"
    },
    "classificationMethod": "MANUAL",
    "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",
    "invoiceDate": "2019-08-24T14:15:22Z",
    "invoiceNumber": "string",
    "linkedPurchaseOrders": [
      {
        "allocatedAmount": 0.1,
        "costType": "PRODUCT",
        "created": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "purchaseOrderId": "string",
        "stockAdjustmentApplied": true
      }
    ],
    "note": "string",
    "outstandingAmount": 0.1,
    "paidAmount": 0.1,
    "paidDate": "2019-08-24T14:15:22Z",
    "paymentStatus": "UNPAID",
    "payments": [
      {
        "amount": 0.1,
        "bankTransactionId": "string",
        "created": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "date": "2019-08-24T14:15:22Z",
        "id": "string",
        "note": "string",
        "paymentMethod": "BANK_TRANSFER",
        "reference": "string"
      }
    ],
    "pdf": {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    },
    "receivedDate": "2019-08-24T14:15:22Z",
    "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
      }
    ],
    "status": "DRAFT",
    "subsidiaryId": "string",
    "subtotal": 0.1,
    "supplierId": "string",
    "supplierName": "string",
    "taxAmount": 0.1,
    "tenantId": "string",
    "totalAmount": 0.1,
    "totalLinkedAmount": 0.1,
    "unlinkedAmount": 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

Authorization

AuthorizationBearer <token>

In: header

Response Body

`application/json`

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

[
  {
    "attachments": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "classification": {
      "category": "string",
      "costCenterId": "string",
      "glAccountId": "string",
      "projectId": "string",
      "subcategory": "string"
    },
    "classificationMethod": "MANUAL",
    "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",
    "invoiceDate": "2019-08-24T14:15:22Z",
    "invoiceNumber": "string",
    "linkedPurchaseOrders": [
      {
        "allocatedAmount": 0.1,
        "costType": "PRODUCT",
        "created": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "purchaseOrderId": "string",
        "stockAdjustmentApplied": true
      }
    ],
    "note": "string",
    "outstandingAmount": 0.1,
    "paidAmount": 0.1,
    "paidDate": "2019-08-24T14:15:22Z",
    "paymentStatus": "UNPAID",
    "payments": [
      {
        "amount": 0.1,
        "bankTransactionId": "string",
        "created": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "date": "2019-08-24T14:15:22Z",
        "id": "string",
        "note": "string",
        "paymentMethod": "BANK_TRANSFER",
        "reference": "string"
      }
    ],
    "pdf": {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    },
    "receivedDate": "2019-08-24T14:15:22Z",
    "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
      }
    ],
    "status": "DRAFT",
    "subsidiaryId": "string",
    "subtotal": 0.1,
    "supplierId": "string",
    "supplierName": "string",
    "taxAmount": 0.1,
    "tenantId": "string",
    "totalAmount": 0.1,
    "totalLinkedAmount": 0.1,
    "unlinkedAmount": 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

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids?array<>

Response Body

`application/json`

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

[
  {
    "attachments": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "classification": {
      "category": "string",
      "costCenterId": "string",
      "glAccountId": "string",
      "projectId": "string",
      "subcategory": "string"
    },
    "classificationMethod": "MANUAL",
    "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",
    "invoiceDate": "2019-08-24T14:15:22Z",
    "invoiceNumber": "string",
    "linkedPurchaseOrders": [
      {
        "allocatedAmount": 0.1,
        "costType": "PRODUCT",
        "created": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "purchaseOrderId": "string",
        "stockAdjustmentApplied": true
      }
    ],
    "note": "string",
    "outstandingAmount": 0.1,
    "paidAmount": 0.1,
    "paidDate": "2019-08-24T14:15:22Z",
    "paymentStatus": "UNPAID",
    "payments": [
      {
        "amount": 0.1,
        "bankTransactionId": "string",
        "created": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "date": "2019-08-24T14:15:22Z",
        "id": "string",
        "note": "string",
        "paymentMethod": "BANK_TRANSFER",
        "reference": "string"
      }
    ],
    "pdf": {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    },
    "receivedDate": "2019-08-24T14:15:22Z",
    "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
      }
    ],
    "status": "DRAFT",
    "subsidiaryId": "string",
    "subtotal": 0.1,
    "supplierId": "string",
    "supplierName": "string",
    "taxAmount": 0.1,
    "tenantId": "string",
    "totalAmount": 0.1,
    "totalLinkedAmount": 0.1,
    "unlinkedAmount": 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

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

`application/json`

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

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "classification": {
    "category": "string",
    "costCenterId": "string",
    "glAccountId": "string",
    "projectId": "string",
    "subcategory": "string"
  },
  "classificationMethod": "MANUAL",
  "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",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "linkedPurchaseOrders": [
    {
      "allocatedAmount": 0.1,
      "costType": "PRODUCT",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "purchaseOrderId": "string",
      "stockAdjustmentApplied": true
    }
  ],
  "note": "string",
  "outstandingAmount": 0.1,
  "paidAmount": 0.1,
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentStatus": "UNPAID",
  "payments": [
    {
      "amount": 0.1,
      "bankTransactionId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "id": "string",
      "note": "string",
      "paymentMethod": "BANK_TRANSFER",
      "reference": "string"
    }
  ],
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "receivedDate": "2019-08-24T14:15:22Z",
  "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
    }
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "tenantId": "string",
  "totalAmount": 0.1,
  "totalLinkedAmount": 0.1,
  "unlinkedAmount": 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"
}

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/ap-invoices/page"

{
  "content": [
    {
      "attachments": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "classification": {
        "category": "string",
        "costCenterId": "string",
        "glAccountId": "string",
        "projectId": "string",
        "subcategory": "string"
      },
      "classificationMethod": "MANUAL",
      "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",
      "invoiceDate": "2019-08-24T14:15:22Z",
      "invoiceNumber": "string",
      "linkedPurchaseOrders": [
        {
          "allocatedAmount": 0.1,
          "costType": "PRODUCT",
          "created": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "purchaseOrderId": "string",
          "stockAdjustmentApplied": true
        }
      ],
      "note": "string",
      "outstandingAmount": 0.1,
      "paidAmount": 0.1,
      "paidDate": "2019-08-24T14:15:22Z",
      "paymentStatus": "UNPAID",
      "payments": [
        {
          "amount": 0.1,
          "bankTransactionId": "string",
          "created": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "date": "2019-08-24T14:15:22Z",
          "id": "string",
          "note": "string",
          "paymentMethod": "BANK_TRANSFER",
          "reference": "string"
        }
      ],
      "pdf": {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      },
      "receivedDate": "2019-08-24T14:15:22Z",
      "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
        }
      ],
      "status": "DRAFT",
      "subsidiaryId": "string",
      "subtotal": 0.1,
      "supplierId": "string",
      "supplierName": "string",
      "taxAmount": 0.1,
      "tenantId": "string",
      "totalAmount": 0.1,
      "totalLinkedAmount": 0.1,
      "unlinkedAmount": 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 AP invoices with enriched data

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

pageable*

search?string

Default""

Response Body

`application/json`

curl -X GET "http://localhost:18080/api/v1/ap-invoices/page-enriched?page=0&size=1&sort=string"

{
  "content": [
    {
      "attachments": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "classification": {
        "category": "string",
        "costCenterId": "string",
        "glAccountId": "string",
        "projectId": "string",
        "subcategory": "string"
      },
      "classificationMethod": "MANUAL",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "currency": "string",
      "daysOverdue": 0,
      "dueDate": "2019-08-24T14:15:22Z",
      "id": "string",
      "invoiceDate": "2019-08-24T14:15:22Z",
      "invoiceNumber": "string",
      "isOverdue": true,
      "linkedPurchaseOrders": [
        {
          "allocatedAmount": 0.1,
          "costType": "string",
          "created": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "purchaseOrderId": "string",
          "purchaseOrderNumber": "string",
          "purchaseOrderStatus": "string",
          "purchaseOrderTotal": 0.1,
          "stockAdjustmentApplied": true
        }
      ],
      "note": "string",
      "outstandingAmount": 0.1,
      "paidAmount": 0.1,
      "paidDate": "2019-08-24T14:15:22Z",
      "paymentStatus": "UNPAID",
      "payments": [
        {
          "amount": 0.1,
          "bankTransactionId": "string",
          "created": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "date": "2019-08-24T14:15:22Z",
          "id": "string",
          "note": "string",
          "paymentMethod": "BANK_TRANSFER",
          "reference": "string"
        }
      ],
      "pdf": {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      },
      "receivedDate": "2019-08-24T14:15:22Z",
      "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
        }
      ],
      "status": "DRAFT",
      "subsidiaryId": "string",
      "subtotal": 0.1,
      "supplierEmail": "string",
      "supplierId": "string",
      "supplierName": "string",
      "taxAmount": 0.1,
      "tenantId": "string",
      "totalAmount": 0.1,
      "totalLinkedAmount": 0.1,
      "unlinkedAmount": 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 AP invoice statistics

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

subsidiaryId?string

Response Body

`application/json`

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

{
  "overdueAmount": 0.1,
  "overdueCount": 0,
  "totalAmount": 0.1,
  "totalInvoices": 0,
  "totalOutstanding": 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"
}

Update an AP invoice

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

classification?

currency?string

dueDate?string

Formatdate-time

invoiceDate?string

Formatdate-time

invoiceNumber?string

note?string

receivedDate?string

Formatdate-time

referenceNumber?string

supplierId?string

Response Body

`application/json`

curl -X PATCH "http://localhost:18080/api/v1/ap-invoices/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "classification": {
    "category": "string",
    "costCenterId": "string",
    "glAccountId": "string",
    "projectId": "string",
    "subcategory": "string"
  },
  "classificationMethod": "MANUAL",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "daysOverdue": 0,
  "dueDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "isOverdue": true,
  "linkedPurchaseOrders": [
    {
      "allocatedAmount": 0.1,
      "costType": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "purchaseOrderId": "string",
      "purchaseOrderNumber": "string",
      "purchaseOrderStatus": "string",
      "purchaseOrderTotal": 0.1,
      "stockAdjustmentApplied": true
    }
  ],
  "note": "string",
  "outstandingAmount": 0.1,
  "paidAmount": 0.1,
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentStatus": "UNPAID",
  "payments": [
    {
      "amount": 0.1,
      "bankTransactionId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "id": "string",
      "note": "string",
      "paymentMethod": "BANK_TRANSFER",
      "reference": "string"
    }
  ],
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "receivedDate": "2019-08-24T14:15:22Z",
  "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
    }
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "tenantId": "string",
  "totalAmount": 0.1,
  "totalLinkedAmount": 0.1,
  "unlinkedAmount": 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"
}

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/ap-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"
}

Apply landed cost adjustment to stock

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

distributionMethod*string

Value in"BY_VALUE" | "BY_QUANTITY" | "BY_WEIGHT" | "EQUAL"

note?string

purchaseOrderId*string

Response Body

`application/json`

curl -X POST "http://localhost:18080/api/v1/ap-invoices/string/apply-landed-cost" \  -H "Content-Type: application/json" \  -d '{    "distributionMethod": "BY_VALUE",    "purchaseOrderId": "string"  }'

{
  "adjustmentsApplied": 0,
  "apInvoiceId": "string",
  "message": "string",
  "purchaseOrderId": "string",
  "stockTransactionIds": [
    "string"
  ],
  "success": true,
  "totalCostDistributed": 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"
}

Upload attachments to an AP invoice

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*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/ap-invoices/string/attachments" \  -F files="[\n  \"string\"\n]"

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "classification": {
    "category": "string",
    "costCenterId": "string",
    "glAccountId": "string",
    "projectId": "string",
    "subcategory": "string"
  },
  "classificationMethod": "MANUAL",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "daysOverdue": 0,
  "dueDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "isOverdue": true,
  "linkedPurchaseOrders": [
    {
      "allocatedAmount": 0.1,
      "costType": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "purchaseOrderId": "string",
      "purchaseOrderNumber": "string",
      "purchaseOrderStatus": "string",
      "purchaseOrderTotal": 0.1,
      "stockAdjustmentApplied": true
    }
  ],
  "note": "string",
  "outstandingAmount": 0.1,
  "paidAmount": 0.1,
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentStatus": "UNPAID",
  "payments": [
    {
      "amount": 0.1,
      "bankTransactionId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "id": "string",
      "note": "string",
      "paymentMethod": "BANK_TRANSFER",
      "reference": "string"
    }
  ],
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "receivedDate": "2019-08-24T14:15:22Z",
  "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
    }
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "tenantId": "string",
  "totalAmount": 0.1,
  "totalLinkedAmount": 0.1,
  "unlinkedAmount": 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"
}

Delete an attachment from an AP invoice

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

blobId*string

Response Body

`application/json`

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

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "classification": {
    "category": "string",
    "costCenterId": "string",
    "glAccountId": "string",
    "projectId": "string",
    "subcategory": "string"
  },
  "classificationMethod": "MANUAL",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "daysOverdue": 0,
  "dueDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "isOverdue": true,
  "linkedPurchaseOrders": [
    {
      "allocatedAmount": 0.1,
      "costType": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "purchaseOrderId": "string",
      "purchaseOrderNumber": "string",
      "purchaseOrderStatus": "string",
      "purchaseOrderTotal": 0.1,
      "stockAdjustmentApplied": true
    }
  ],
  "note": "string",
  "outstandingAmount": 0.1,
  "paidAmount": 0.1,
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentStatus": "UNPAID",
  "payments": [
    {
      "amount": 0.1,
      "bankTransactionId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "id": "string",
      "note": "string",
      "paymentMethod": "BANK_TRANSFER",
      "reference": "string"
    }
  ],
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "receivedDate": "2019-08-24T14:15:22Z",
  "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
    }
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "tenantId": "string",
  "totalAmount": 0.1,
  "totalLinkedAmount": 0.1,
  "unlinkedAmount": 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"
}

Cancel an AP invoice

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Query Parameters

reason?string

Response Body

`application/json`

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

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "classification": {
    "category": "string",
    "costCenterId": "string",
    "glAccountId": "string",
    "projectId": "string",
    "subcategory": "string"
  },
  "classificationMethod": "MANUAL",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "daysOverdue": 0,
  "dueDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "isOverdue": true,
  "linkedPurchaseOrders": [
    {
      "allocatedAmount": 0.1,
      "costType": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "purchaseOrderId": "string",
      "purchaseOrderNumber": "string",
      "purchaseOrderStatus": "string",
      "purchaseOrderTotal": 0.1,
      "stockAdjustmentApplied": true
    }
  ],
  "note": "string",
  "outstandingAmount": 0.1,
  "paidAmount": 0.1,
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentStatus": "UNPAID",
  "payments": [
    {
      "amount": 0.1,
      "bankTransactionId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "id": "string",
      "note": "string",
      "paymentMethod": "BANK_TRANSFER",
      "reference": "string"
    }
  ],
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "receivedDate": "2019-08-24T14:15:22Z",
  "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
    }
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "tenantId": "string",
  "totalAmount": 0.1,
  "totalLinkedAmount": 0.1,
  "unlinkedAmount": 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"
}

Add a comment to an AP invoice

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/ap-invoices/string/comments" \  -H "Content-Type: application/json" \  -d 'string'

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "classification": {
    "category": "string",
    "costCenterId": "string",
    "glAccountId": "string",
    "projectId": "string",
    "subcategory": "string"
  },
  "classificationMethod": "MANUAL",
  "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",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "linkedPurchaseOrders": [
    {
      "allocatedAmount": 0.1,
      "costType": "PRODUCT",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "purchaseOrderId": "string",
      "stockAdjustmentApplied": true
    }
  ],
  "note": "string",
  "outstandingAmount": 0.1,
  "paidAmount": 0.1,
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentStatus": "UNPAID",
  "payments": [
    {
      "amount": 0.1,
      "bankTransactionId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "id": "string",
      "note": "string",
      "paymentMethod": "BANK_TRANSFER",
      "reference": "string"
    }
  ],
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "receivedDate": "2019-08-24T14:15:22Z",
  "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
    }
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "tenantId": "string",
  "totalAmount": 0.1,
  "totalLinkedAmount": 0.1,
  "unlinkedAmount": 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"
}

Get an AP invoice with enriched data

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

`application/json`

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

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "classification": {
    "category": "string",
    "costCenterId": "string",
    "glAccountId": "string",
    "projectId": "string",
    "subcategory": "string"
  },
  "classificationMethod": "MANUAL",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "daysOverdue": 0,
  "dueDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "isOverdue": true,
  "linkedPurchaseOrders": [
    {
      "allocatedAmount": 0.1,
      "costType": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "purchaseOrderId": "string",
      "purchaseOrderNumber": "string",
      "purchaseOrderStatus": "string",
      "purchaseOrderTotal": 0.1,
      "stockAdjustmentApplied": true
    }
  ],
  "note": "string",
  "outstandingAmount": 0.1,
  "paidAmount": 0.1,
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentStatus": "UNPAID",
  "payments": [
    {
      "amount": 0.1,
      "bankTransactionId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "id": "string",
      "note": "string",
      "paymentMethod": "BANK_TRANSFER",
      "reference": "string"
    }
  ],
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "receivedDate": "2019-08-24T14:15:22Z",
  "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
    }
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "tenantId": "string",
  "totalAmount": 0.1,
  "totalLinkedAmount": 0.1,
  "unlinkedAmount": 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"
}

Preview landed cost adjustment for a PO

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

purchaseOrderId*string

Response Body

`application/json`

curl -X GET "http://localhost:18080/api/v1/ap-invoices/string/landed-cost-preview/string"

{
  "adjustments": [
    {
      "costAllocation": 0.1,
      "currentQuantity": 0.1,
      "currentTotalValue": 0.1,
      "currentUnitPrice": 0.1,
      "newUnitPrice": 0.1,
      "priceIncrease": 0.1,
      "priceIncreasePercent": 0.1,
      "productId": "string",
      "productName": "string",
      "proportionOfPO": 0.1,
      "stockSiteId": "string",
      "stockSiteName": "string"
    }
  ],
  "allocatedAmount": 0.1,
  "alreadyApplied": true,
  "apInvoiceId": "string",
  "costType": "PRODUCT",
  "distributionMethod": "BY_VALUE",
  "purchaseOrderId": "string",
  "totalCostToDistribute": 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"
}

Link an AP invoice to a purchase order

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

allocatedAmount*number

Formatdouble

costType*string

purchaseOrderId*string

Response Body

`application/json`

curl -X POST "http://localhost:18080/api/v1/ap-invoices/string/link-po" \  -H "Content-Type: application/json" \  -d '{    "allocatedAmount": 0.1,    "costType": "PRODUCT",    "purchaseOrderId": "string"  }'

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "classification": {
    "category": "string",
    "costCenterId": "string",
    "glAccountId": "string",
    "projectId": "string",
    "subcategory": "string"
  },
  "classificationMethod": "MANUAL",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "daysOverdue": 0,
  "dueDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "isOverdue": true,
  "linkedPurchaseOrders": [
    {
      "allocatedAmount": 0.1,
      "costType": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "purchaseOrderId": "string",
      "purchaseOrderNumber": "string",
      "purchaseOrderStatus": "string",
      "purchaseOrderTotal": 0.1,
      "stockAdjustmentApplied": true
    }
  ],
  "note": "string",
  "outstandingAmount": 0.1,
  "paidAmount": 0.1,
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentStatus": "UNPAID",
  "payments": [
    {
      "amount": 0.1,
      "bankTransactionId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "id": "string",
      "note": "string",
      "paymentMethod": "BANK_TRANSFER",
      "reference": "string"
    }
  ],
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "receivedDate": "2019-08-24T14:15:22Z",
  "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
    }
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "tenantId": "string",
  "totalAmount": 0.1,
  "totalLinkedAmount": 0.1,
  "unlinkedAmount": 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"
}

Unlink an AP invoice from a purchase order

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

purchaseOrderId*string

Response Body

`application/json`

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

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "classification": {
    "category": "string",
    "costCenterId": "string",
    "glAccountId": "string",
    "projectId": "string",
    "subcategory": "string"
  },
  "classificationMethod": "MANUAL",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "daysOverdue": 0,
  "dueDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "isOverdue": true,
  "linkedPurchaseOrders": [
    {
      "allocatedAmount": 0.1,
      "costType": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "purchaseOrderId": "string",
      "purchaseOrderNumber": "string",
      "purchaseOrderStatus": "string",
      "purchaseOrderTotal": 0.1,
      "stockAdjustmentApplied": true
    }
  ],
  "note": "string",
  "outstandingAmount": 0.1,
  "paidAmount": 0.1,
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentStatus": "UNPAID",
  "payments": [
    {
      "amount": 0.1,
      "bankTransactionId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "id": "string",
      "note": "string",
      "paymentMethod": "BANK_TRANSFER",
      "reference": "string"
    }
  ],
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "receivedDate": "2019-08-24T14:15:22Z",
  "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
    }
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "tenantId": "string",
  "totalAmount": 0.1,
  "totalLinkedAmount": 0.1,
  "unlinkedAmount": 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"
}

Update PO link allocation

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

purchaseOrderId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

allocatedAmount*number

Formatdouble

costType*string

purchaseOrderId*string

Response Body

`application/json`

curl -X PUT "http://localhost:18080/api/v1/ap-invoices/string/link-po/string" \  -H "Content-Type: application/json" \  -d '{    "allocatedAmount": 0.1,    "costType": "PRODUCT",    "purchaseOrderId": "string"  }'

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "classification": {
    "category": "string",
    "costCenterId": "string",
    "glAccountId": "string",
    "projectId": "string",
    "subcategory": "string"
  },
  "classificationMethod": "MANUAL",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "daysOverdue": 0,
  "dueDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "isOverdue": true,
  "linkedPurchaseOrders": [
    {
      "allocatedAmount": 0.1,
      "costType": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "purchaseOrderId": "string",
      "purchaseOrderNumber": "string",
      "purchaseOrderStatus": "string",
      "purchaseOrderTotal": 0.1,
      "stockAdjustmentApplied": true
    }
  ],
  "note": "string",
  "outstandingAmount": 0.1,
  "paidAmount": 0.1,
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentStatus": "UNPAID",
  "payments": [
    {
      "amount": 0.1,
      "bankTransactionId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "id": "string",
      "note": "string",
      "paymentMethod": "BANK_TRANSFER",
      "reference": "string"
    }
  ],
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "receivedDate": "2019-08-24T14:15:22Z",
  "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
    }
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "tenantId": "string",
  "totalAmount": 0.1,
  "totalLinkedAmount": 0.1,
  "unlinkedAmount": 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"
}

Mark an AP invoice as open (ready for payment)

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

`application/json`

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

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "classification": {
    "category": "string",
    "costCenterId": "string",
    "glAccountId": "string",
    "projectId": "string",
    "subcategory": "string"
  },
  "classificationMethod": "MANUAL",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "daysOverdue": 0,
  "dueDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "isOverdue": true,
  "linkedPurchaseOrders": [
    {
      "allocatedAmount": 0.1,
      "costType": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "purchaseOrderId": "string",
      "purchaseOrderNumber": "string",
      "purchaseOrderStatus": "string",
      "purchaseOrderTotal": 0.1,
      "stockAdjustmentApplied": true
    }
  ],
  "note": "string",
  "outstandingAmount": 0.1,
  "paidAmount": 0.1,
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentStatus": "UNPAID",
  "payments": [
    {
      "amount": 0.1,
      "bankTransactionId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "id": "string",
      "note": "string",
      "paymentMethod": "BANK_TRANSFER",
      "reference": "string"
    }
  ],
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "receivedDate": "2019-08-24T14:15:22Z",
  "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
    }
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "tenantId": "string",
  "totalAmount": 0.1,
  "totalLinkedAmount": 0.1,
  "unlinkedAmount": 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"
}

Add a payment to an AP invoice

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount*number

Formatdouble

bankTransactionId?string

date*string

Formatdate-time

note?string

paymentMethod*string

Value in"BANK_TRANSFER" | "CREDIT_CARD" | "CASH" | "CHECK" | "DIRECT_DEBIT"

reference?string

Response Body

`application/json`

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

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "classification": {
    "category": "string",
    "costCenterId": "string",
    "glAccountId": "string",
    "projectId": "string",
    "subcategory": "string"
  },
  "classificationMethod": "MANUAL",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "daysOverdue": 0,
  "dueDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "isOverdue": true,
  "linkedPurchaseOrders": [
    {
      "allocatedAmount": 0.1,
      "costType": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "purchaseOrderId": "string",
      "purchaseOrderNumber": "string",
      "purchaseOrderStatus": "string",
      "purchaseOrderTotal": 0.1,
      "stockAdjustmentApplied": true
    }
  ],
  "note": "string",
  "outstandingAmount": 0.1,
  "paidAmount": 0.1,
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentStatus": "UNPAID",
  "payments": [
    {
      "amount": 0.1,
      "bankTransactionId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "id": "string",
      "note": "string",
      "paymentMethod": "BANK_TRANSFER",
      "reference": "string"
    }
  ],
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "receivedDate": "2019-08-24T14:15:22Z",
  "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
    }
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "tenantId": "string",
  "totalAmount": 0.1,
  "totalLinkedAmount": 0.1,
  "unlinkedAmount": 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"
}

Remove a payment from an AP invoice

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

paymentId*string

Response Body

`application/json`

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

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "classification": {
    "category": "string",
    "costCenterId": "string",
    "glAccountId": "string",
    "projectId": "string",
    "subcategory": "string"
  },
  "classificationMethod": "MANUAL",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "daysOverdue": 0,
  "dueDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "isOverdue": true,
  "linkedPurchaseOrders": [
    {
      "allocatedAmount": 0.1,
      "costType": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "purchaseOrderId": "string",
      "purchaseOrderNumber": "string",
      "purchaseOrderStatus": "string",
      "purchaseOrderTotal": 0.1,
      "stockAdjustmentApplied": true
    }
  ],
  "note": "string",
  "outstandingAmount": 0.1,
  "paidAmount": 0.1,
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentStatus": "UNPAID",
  "payments": [
    {
      "amount": 0.1,
      "bankTransactionId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "id": "string",
      "note": "string",
      "paymentMethod": "BANK_TRANSFER",
      "reference": "string"
    }
  ],
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "receivedDate": "2019-08-24T14:15:22Z",
  "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
    }
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "tenantId": "string",
  "totalAmount": 0.1,
  "totalLinkedAmount": 0.1,
  "unlinkedAmount": 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"
}

Upload PDF to an AP invoice

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

file*file

Formatbinary

Response Body

`application/json`

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

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "classification": {
    "category": "string",
    "costCenterId": "string",
    "glAccountId": "string",
    "projectId": "string",
    "subcategory": "string"
  },
  "classificationMethod": "MANUAL",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "daysOverdue": 0,
  "dueDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "isOverdue": true,
  "linkedPurchaseOrders": [
    {
      "allocatedAmount": 0.1,
      "costType": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "purchaseOrderId": "string",
      "purchaseOrderNumber": "string",
      "purchaseOrderStatus": "string",
      "purchaseOrderTotal": 0.1,
      "stockAdjustmentApplied": true
    }
  ],
  "note": "string",
  "outstandingAmount": 0.1,
  "paidAmount": 0.1,
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentStatus": "UNPAID",
  "payments": [
    {
      "amount": 0.1,
      "bankTransactionId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "id": "string",
      "note": "string",
      "paymentMethod": "BANK_TRANSFER",
      "reference": "string"
    }
  ],
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "receivedDate": "2019-08-24T14:15:22Z",
  "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
    }
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "tenantId": "string",
  "totalAmount": 0.1,
  "totalLinkedAmount": 0.1,
  "unlinkedAmount": 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"
}

Add a row to an AP invoice

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

description?string

glAccountId?string

productId?string

quantity*number

Formatdouble

taxRate?number

Formatdouble

unitPrice*number

Formatdouble

Response Body

`application/json`

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

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "classification": {
    "category": "string",
    "costCenterId": "string",
    "glAccountId": "string",
    "projectId": "string",
    "subcategory": "string"
  },
  "classificationMethod": "MANUAL",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "daysOverdue": 0,
  "dueDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "isOverdue": true,
  "linkedPurchaseOrders": [
    {
      "allocatedAmount": 0.1,
      "costType": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "purchaseOrderId": "string",
      "purchaseOrderNumber": "string",
      "purchaseOrderStatus": "string",
      "purchaseOrderTotal": 0.1,
      "stockAdjustmentApplied": true
    }
  ],
  "note": "string",
  "outstandingAmount": 0.1,
  "paidAmount": 0.1,
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentStatus": "UNPAID",
  "payments": [
    {
      "amount": 0.1,
      "bankTransactionId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "id": "string",
      "note": "string",
      "paymentMethod": "BANK_TRANSFER",
      "reference": "string"
    }
  ],
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "receivedDate": "2019-08-24T14:15:22Z",
  "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
    }
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "tenantId": "string",
  "totalAmount": 0.1,
  "totalLinkedAmount": 0.1,
  "unlinkedAmount": 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"
}

Remove a row from an AP invoice

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

rowId*string

Response Body

`application/json`

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

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "classification": {
    "category": "string",
    "costCenterId": "string",
    "glAccountId": "string",
    "projectId": "string",
    "subcategory": "string"
  },
  "classificationMethod": "MANUAL",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "daysOverdue": 0,
  "dueDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "isOverdue": true,
  "linkedPurchaseOrders": [
    {
      "allocatedAmount": 0.1,
      "costType": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "purchaseOrderId": "string",
      "purchaseOrderNumber": "string",
      "purchaseOrderStatus": "string",
      "purchaseOrderTotal": 0.1,
      "stockAdjustmentApplied": true
    }
  ],
  "note": "string",
  "outstandingAmount": 0.1,
  "paidAmount": 0.1,
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentStatus": "UNPAID",
  "payments": [
    {
      "amount": 0.1,
      "bankTransactionId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "id": "string",
      "note": "string",
      "paymentMethod": "BANK_TRANSFER",
      "reference": "string"
    }
  ],
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "receivedDate": "2019-08-24T14:15:22Z",
  "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
    }
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "tenantId": "string",
  "totalAmount": 0.1,
  "totalLinkedAmount": 0.1,
  "unlinkedAmount": 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"
}

Update a row in an AP invoice

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

rowId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

description?string

glAccountId?string

productId?string

quantity*number

Formatdouble

taxRate?number

Formatdouble

unitPrice*number

Formatdouble

Response Body

`application/json`

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

{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "classification": {
    "category": "string",
    "costCenterId": "string",
    "glAccountId": "string",
    "projectId": "string",
    "subcategory": "string"
  },
  "classificationMethod": "MANUAL",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "daysOverdue": 0,
  "dueDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "isOverdue": true,
  "linkedPurchaseOrders": [
    {
      "allocatedAmount": 0.1,
      "costType": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "purchaseOrderId": "string",
      "purchaseOrderNumber": "string",
      "purchaseOrderStatus": "string",
      "purchaseOrderTotal": 0.1,
      "stockAdjustmentApplied": true
    }
  ],
  "note": "string",
  "outstandingAmount": 0.1,
  "paidAmount": 0.1,
  "paidDate": "2019-08-24T14:15:22Z",
  "paymentStatus": "UNPAID",
  "payments": [
    {
      "amount": 0.1,
      "bankTransactionId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "id": "string",
      "note": "string",
      "paymentMethod": "BANK_TRANSFER",
      "reference": "string"
    }
  ],
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "receivedDate": "2019-08-24T14:15:22Z",
  "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
    }
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "subtotal": 0.1,
  "supplierEmail": "string",
  "supplierId": "string",
  "supplierName": "string",
  "taxAmount": 0.1,
  "tenantId": "string",
  "totalAmount": 0.1,
  "totalLinkedAmount": 0.1,
  "unlinkedAmount": 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"
}

A P Invoices

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

200application/json

400application/json

403application/json

500application/json

204

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`