CreditNotes
Void Credit Note
Changed onpost/api/v1/CreditNotes/void
Request
- Base URLhttps://api.peakaccount.com
- Authnone declared. Required headers: Time-Stamp, Time-Signature, User-Token, Client-Token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
isVoidETaxInvoice0 | 1
Numeric code indicating whether to also void the linked e-Tax Invoice. Defaults to 0
Headers
Time-Stampstring required
Timestamp (yyyyMMddHHmmss)
Time-Signaturestring required
HMAC-SHA1 encrypted Time-Stamp where Secret Key is connectId
User-Tokenstring required
This token will be generated by PEAK.
Client-Tokenstring required
Token used to identify between client and PEAK to call API.
Request body
Response
Success
Changes
- breaking
removed the media type
application/*+jsonfrom the request body - breaking
removed the media type
application/json-patch+jsonfrom the request body - breaking
removed the media type
text/jsonfrom the request body - breaking
the
queryrequest parameterisVoidETaxInvoicewas restricted to a list of enum values - breaking
the request property
became required - info
added the new enum value
0.00to thequeryrequest parameterisVoidETaxInvoice - info
added the new enum value
1.00to thequeryrequest parameterisVoidETaxInvoice
- breaking