---
title: "Modify_PaymentStatement"
method: POST
path: "/api/PurchaseOrder/Modify_PaymentStatement"
tags: ["PurchaseOrder"]
---

# Modify_PaymentStatement

`POST /api/PurchaseOrder/Modify_PaymentStatement`

Modify purchase order payment statements. You can add new lines, update and delete existing. The method will return modified list back to you with each record identified by unique identifier.
<b>Permissions Required: </b> GlobalPermissions.Inventory.PurchaseOrder.EditPurchaseOrderNode
<b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>150</b></span> / minute

## Request body

- PurchaseOrderModifyPaymentStatementRequest
  - `request` ModifyPaymentStatementRequest
    - `itemsToAdd` AddPaymentStatementItem[] — list of payment statements to add. Each item has Id which will be returned to you to match the item you are adding to array on your side
      - `Id` string, uuid — Each item in the request can have unique Id supplied (uniqueidentifier) this Id will be returned to you in the response so you can match request item with the response
      - `Reference` string — Payment statement reference
      - `ConversionRate` number, double — Conversion rate from system currency, i.e. system currency rate to additional cost currency. For example if your system currency is GBP and payment statementis in USD the converted value is USD / Rate, example calculation, Rate 1.27, Additional cost total is 100, converted value = 100 USD / 1.27 = 78.98 GBP
      - `Currency` string — Currency code
      - `fkPurchaseAdditionalCostItemId` integer — Relation to additional cost line. If no value is set then the payment statement relates to PO supplier
      - `LineCost` number, double — Cost of the purchase order the payment contributes to
      - `PaymentDate` string, date-time — Date when payment statement was marked as paid
      - `CreationDate` string, date-time — Date when the payment statement was added
    - `itemsToUpdate` UpdatePaymentStatementItem[] — List of payment statements to update. Each line is identified by
      - `PurchasePaymentStatementId` integer — Payment Statement line row id, uniquely identifying each cost line
      - `Id` string, uuid — Each item in the request can have unique Id supplied (uniqueidentifier) this Id will be returned to you in the response so you can match request item with the response
      - `Reference` string — Payment statement reference
      - `ConversionRate` number, double — Conversion rate from system currency, i.e. system currency rate to additional cost currency. For example if your system currency is GBP and payment statementis in USD the converted value is USD / Rate, example calculation, Rate 1.27, Additional cost total is 100, converted value = 100 USD / 1.27 = 78.98 GBP
      - `Currency` string — Currency code
      - `fkPurchaseAdditionalCostItemId` integer — Relation to additional cost line. If no value is set then the payment statement relates to PO supplier
      - `LineCost` number, double — Cost of the purchase order the payment contributes to
      - `PaymentDate` string, date-time — Date when payment statement was marked as paid
      - `CreationDate` string, date-time — Date when the payment statement was added
    - `itemsToDelete` integer[] — List of payment statements to delete, provide list of PurchasePaymentStatementId's
    - `PurchaseId` string, uuid — Purchase order id

## Response `200`

OK

- PurchaseOrderModifyPaymentStatementResponse
  - `ModifiedItems` ModifiedPaymentStatementItem[] — List of modified items, added or updated. Each item has Id which was provided in the request
    - `Id` string, uuid — Each item in the request can have unique Id supplied (uniqueidentifier) this Id will be returned to you in the response so you can match request item with the response
    - `PurchasePaymentStatementId` integer — Unique record id
    - `LineCost` number, double — Cost of the purchase order the payment contributes to
    - `ConversionRate` number, double — Conversion rate from system currency, i.e. system currency rate to additional cost currency. For example if your system currency is GBP and payment statement cost is in USD the converted value is USD / Rate, example calculation, Rate 1.27, Additional cost total is 100, converted value = 100 USD / 1.27 = 78.98 GBP
    - `Currency` string — Currency code
    - `Reference` string — Payment Statement reference
    - `CreationDate` string, date-time — Date when the payment statement was added
    - `PaymentDate` string, date-time — Date when payment statement was marked as paid
    - `fkPurchaseAdditionalCostItemId` integer — Relation to additional cost line. If no value is set then the payment statement relates to PO supplier

---

[API](https://skmtc.net/linnworks/apis/authenticate-api.md) · [All operations](https://skmtc.net/linnworks/apis/authenticate-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/linnworks/authenticate-api/versions/0123569a22fb/schema)