--- title: "Edit Goods Receipt" method: POST path: "/api/v1/GoodsReceipts/edit" tags: ["GoodsReceipts"] --- # Edit Goods Receipt `POST /api/v1/GoodsReceipts/edit` ## Request - Base URL: `https://api.peakaccount.com` - URL: `https://api.peakaccount.com/api/v1/GoodsReceipts/edit` - Auth: none declared. Required headers: `Time-Stamp`, `Time-Signature`, `User-Token`, `Client-Token` - TypeScript: (a function with typed inputs; its response is checked against the schema) ## Query parameters - `getResult` 0 | 1: Numeric code indicating whether the result data is returned in the response ## Headers - `Time-Stamp` string, required - `Time-Signature` string, required - `User-Token` string, required - `Client-Token` string, required ## Request body - object - `peakGoodsReceipts` object, required - `code` string, required: The code of the goods receipt to be edited - `goodsReceipt` object, required - `code` string: The code displayed in the PEAK. If no value is provided, PEAK will generate it automatically - `issuedDate` string, required: Document issuance date - `dueDate` string: Document due date, which must be after the document issuance date - `contactId` string: Unique Identifier of the contact associated with the document - `contactCode` string: Code of the contact associated with the document (If contactId has been assigned a value, contactCode is not required) - `reference` string: Reference information of the document - `remark` string: Additional remarks or notes - `taxStatus` 0 | 1 | 2: Specify the tax status of the document to indicate whether the price includes tax or the tax is separate - `discountTotal` string: The total discount should not exceed the net total of the document or be greater than 100%. Additionally, it can only be applied when the tax type of each item is the same - `isTaxInvoice` 0 | 1: isTaxInvoice status indicating whether the document can be used as a tax invoice or not - `tags` string[]: Label attached to someone or something for the purpose of identification or to give other information - `products` object[], required - `id` string: The Unique Identifier of an existing line on the document (used when editing a document) - `productId` string: The Unique Identifier of the product/service for this line. Send productId or productCode, not both - `productCode` string: Code of the product/service for this line, used as an alternative to productId - `description` string: Description of the line. Required when isDescription is 1, or when the line has no product/service and no accountCode - `accountCode` string: Account code to record this line in. Used when the line is not linked to a product/service - `accountSubId` string: The Unique Identifier of the sub account under accountCode. Send accountSubId or accountSubCode, not both - `accountSubCode` string: Code of the sub account under accountCode, used as an alternative to accountSubId - `quantity` number, double, required: Quantity of the line. Required unless isDescription is 1 - `price` number, double, required: Price per unit of the line. Required unless isDescription is 1 - `discount` string: Discount of the line, as an amount (e.g. "100") or a percentage (e.g. "10%"). Must not be negative - `vatType` 1 | 2 | 3, required: Numeric code indicating the VAT rate of the line - `isDescription` 0 | 1: Numeric code indicating whether this line is a description-only text row - `withHoldingTaxAmount` string: Withholding tax of the line, as an amount (e.g. "30") or a percentage of the line net amount (e.g. "3%") - `paidPayments` PeakAPIsLibraryModelRequestTransactionSharedNormalPaymentsTransaction - `payments` PeakAPIsLibraryModelRequestTransactionSharedNormalPayment[]: The object with payment details - `cheque` PeakAPIsLibraryModelRequestTransactionSharedNormalCheque - `accountNo` string: Bank account number - `branchNo` string: Bank branch number - `chequeNo` string: Cheque number - `amount` number, double: Amount specified in the Cheque - `chequeDate` string: Cheque issuance date in the format yyyyMMdd - `bankId` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37: The numerical code that indicates a financial institution - `paymentMethodId` string: The Unique Identifier of the payment method used to record the Cheque payment - `paymentMethodCode` string: The Code of the payment method used to record the Cheque payment - `note` string: Additional remarks or notes for that specific payment received - `isCheque` 0 | 1: The numerical code indicating whether this payment is made by Cheque or not - `amount` number, double: Payment amount - `paymentMethodId` string: The Unique Identifier of the payment method - `paymentMethodCode` string: Code of the payment method (If paymentMethodId has been assigned a value, paymentMethodCode is not required) - `accountCode` string: Account code to be used for recording financial transactions - `accountSubId` string: Sub account Unique Identifier to be used for recording financial transactions - `accountSubCode` string: Sub account code to be used for recording financial transactions - `paymentDate` string: Payment date in the format yyyyMMdd - `withHoldingTaxAmount` string: Withholding tax deducted from this payment, as an amount (e.g. "30") or a percentage (e.g. "3%") - `status` 'Draft' | 'Approve': Status to create the document with: Draft (save as draft) or Approve (create and approve). If omitted, the document is approved - `preTaxAmount` number, double: Amount before tax is applied (If value is null, PEAK will calculate it automatically) - `vatAmount` number, double: Tax collected from the increased value of products or services (If value is null, PEAK will calculate it automatically) - `netAmount` number, double: Total value of the document after tax and discounts have been applied (If value is null, PEAK will calculate it automatically) - `currency` PeakAPIsLibraryModelRequestTransactionSharedNormalCurrencyTransaction - `currencyId` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48: Numeric code indicating the currency of the document - `exchangeRate` number, double: Exchange rate from the document currency to THB. Required for invoices and receipts - `receivedTaxInvoice` PeakAPIsLibraryModelRequestTransactionSharedNormalReceivedTaxInvoiceTransaction - `taxInvoiceNumber` string: Number of the tax invoice received from the supplier - `taxInvoiceDate` string: Date of the tax invoice received from the supplier (yyyyMMdd) - `journalDate` string: Date the received tax invoice is recorded (yyyyMMdd) - `periodDate` string: Tax period the received tax invoice is claimed in (yyyyMMdd) - `getResult` 0 | 1: Numeric code indicating whether the result data is returned in the response ## Response `200` Success - PeakAPIsLibraryModelResponseGoodsReceiptsResponseGoodsReceiptModel - `peakGoodsReceipts` PeakAPIsLibraryModelResponseGoodsReceiptsAPIBodyGoodsReceipt - `goodsReceipts` PeakAPIsLibraryModelGoodsReceiptsAPIGoodsReceiptModel[] - `id` string - `code` string - `issuedDate` string - `contactId` string - `status` integer - `isAllocation` boolean - `referenceName` string - `preTaxAmount` number, double - `vatAmount` number, double - `netAmount` number, double - `whtAmount` number, double - `referenceTransactionId` string - `referenceTransactionType` integer - `warehouseId` integer - `products` PeakAPIsLibraryModelResponseSharedAPITransactionProducts[] - `id` string - `productId` string - `productCode` string - `accountCode` string - `accountSubId` string - `accountSubCode` string - `description` string - `quantity` number, double - `price` number, double - `discount` string - `vatType` integer - `isDescription` integer - `withHoldingTaxAmount` string - `resDesc` string - `resCode` string - `eventType` string - `apiType` string ## Changes - **2026-11-03** `433c913c750f`: 1 info - endpoint added [Operation history](https://skmtc.dev/peakaccount/apis/peakapis-core/changes/api/v1/GoodsReceipts/edit/post.md) --- [API](https://skmtc.dev/peakaccount/apis/peakapis-core.md) - [All operations](https://skmtc.dev/peakaccount/apis/peakapis-core/llms.txt) - [OpenAPI document](https://skmtc.dev/peakaccount/apis/peakapis-core/revisions/433c913c750f?raw)