--- title: "Creates Credit Note with Credit Note Items" url: "https://developer.retailexpress.com.au/apis/retail-express-api-21-v2/versions/d3750347-3c58-45e9-b3b1-b23a00e713ed/operations/post-supplierreturns-id-creditnotes" --- > Full API specification: https://developer.retailexpress.com.au/apis/retail-express-api-21-v2/versions/d3750347-3c58-45e9-b3b1-b23a00e713ed.md # Creates Credit Note with Credit Note Items `POST` `/supplierreturns/{id}/creditnotes` Operation ID: `post-supplierreturns-id-creditnotes` Sample request: POST ​​/supplierreturn​/{id}​/creditnotes { "supplier_reference": "supplier_reference", "credit_note_items": [ { "supplier_return_item_id": 1 }, { "supplier_return_item_id": 2 } ] } ## Path parameters - `id` (integer, int32, required) - Format - int32. Supplier Return id ## Header parameters - `x-api-key` (string, required) - Api subscription key - `Cache-Control` (string, optional) - `Authorization` (string, required) - Bearer token for authorization (e.g., Bearer ) ## Request body Content types: `application/json` ## Responses - `201` - Credit Note model with Credit Note Items were created - `400` - Bad request - `401` - Unauthorized - `403` - Forbidden - `404` - Not found ## OpenAPI definition ```yaml openapi: 3.0.1 info: title: Retail Express API version: V2 servers: - url: https://api.retailexpress.com.au/v2 paths: /supplierreturns/{id}/creditnotes: post: tags: - supplierreturns summary: Creates Credit Note with Credit Note Items description: "Sample request:\r \r \ POST ​​/supplierreturn​/{id}​/creditnotes\r \ {\r \ \"supplier_reference\": \"supplier_reference\",\r \ \"credit_note_items\": [\r \ {\r \ \"supplier_return_item_id\": 1\r \ },\r \ {\r \ \"supplier_return_item_id\": 2\r \ }\r \ ]\r \ }" operationId: post-supplierreturns-id-creditnotes parameters: - name: id in: path description: Format - int32. Supplier Return id required: true schema: type: integer description: Supplier Return id format: int32 - name: x-api-key in: header description: Api subscription key required: true schema: type: string - name: Cache-Control in: header required: false schema: type: string default: no-cache - name: Authorization in: header required: true description: Bearer token for authorization (e.g., Bearer ) schema: type: string requestBody: description: Credit Note to be created content: application/json: schema: title: EmptyExample type: object additionalProperties: false responses: "201": description: Credit Note model with Credit Note Items were created content: application/json: schema: $ref: "#/components/schemas/SupplierReturnsCreditNote" example: id: 0 supplier_return_id: 0 supplier: id: 0 supplier_code: string name: string modified_on: string outlet: id: 0 name: string modified_on: string supplier_reference: string include_tax: false total_credit_quantity: 0 total_credit_amount_ex: 0 total_credit_amount_tax: 0 total_credit_amount_inc: 0 total_applied_credit_quantity: 0 total_applied_credit_amount_ex: 0 total_applied_credit_amount_inc: 0 total_applied_credit_tax: 0 credit_note_items: - id: 0 supplier_return_item_id: 0 created_on: string modified_on: string created_by: id: 0 user_code: string first_name: string surname: string modified_by: id: 0 user_code: string first_name: string surname: string "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ProblemDetails" example: type: string title: string status: 0 detail: string instance: string "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ProblemDetails" example: type: string title: string status: 0 detail: string instance: string "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ProblemDetails" example: type: string title: string status: 0 detail: string instance: string "404": description: Not found content: application/json: schema: $ref: "#/components/schemas/ProblemDetails" example: type: string title: string status: 0 detail: string instance: string security: [] components: schemas: SupplierReturnsCreditNote: title: "" type: object properties: id: type: integer description: Credit Note id format: int32 nullable: true supplier_return_id: type: integer description: Supplier Return id format: int32 nullable: true supplier: $ref: "#/components/schemas/CreditNoteSupplier" outlet: $ref: "#/components/schemas/CreditNoteOutlet" supplier_reference: maxLength: 50 minLength: 0 type: string description: Supplier reference nullable: true include_tax: type: boolean description: Include tax default: false nullable: true total_credit_quantity: type: integer description: Total credit quantity format: int32 total_credit_amount_ex: type: number description: Total Credit Amount Ex format: double total_credit_amount_tax: type: number description: Total Credit Amount Tax format: double total_credit_amount_inc: type: number description: Total Credit Amount Inc format: double total_applied_credit_quantity: type: integer description: Total Applied Credit Quantity format: int32 total_applied_credit_amount_ex: type: number description: Total Applied Credit Amount Ex format: double total_applied_credit_amount_inc: type: number description: Total Applied Credit Amount Inc format: double total_applied_credit_tax: type: number description: Total Applied Credit Tax format: double credit_note_items: type: array items: $ref: "#/components/schemas/SupplierReturnsCreditNoteItem" description: List of Credit Note items nullable: true created_on: type: string description: Created on format: date-time modified_on: type: string description: Modified on format: date-time created_by: $ref: "#/components/schemas/CreditNoteUser" modified_by: $ref: "#/components/schemas/CreditNoteUser" additionalProperties: false description: Credit Note model for ​/supplierreturn​/{id}​/creditnotes endpoint ProblemDetails: title: "" type: object properties: type: type: string nullable: true title: type: string nullable: true status: type: integer format: int32 nullable: true detail: type: string nullable: true instance: type: string nullable: true additionalProperties: {} CreditNoteSupplier: title: "" type: object properties: id: type: integer description: Supplier Id format: int32 nullable: true supplier_code: type: string description: Supplier Code nullable: true name: type: string description: Supplier Name nullable: true modified_on: type: string description: Modified on format: date-time additionalProperties: false description: Supplier model for Credit Notes CreditNoteOutlet: title: "" type: object properties: id: type: integer description: Outlet id format: int32 nullable: true name: type: string description: Outlet name nullable: true modified_on: type: string description: Modified on format: date-time additionalProperties: false description: Outlet model for Credit Notes SupplierReturnsCreditNoteItem: title: "" type: object properties: id: type: integer description: Credit Note Item id format: int32 nullable: true supplier_return_item_id: type: integer description: Supplier Return Item id format: int32 nullable: true additionalProperties: false description: Supplier returns Credit Note item model CreditNoteUser: title: "" type: object properties: id: type: integer description: Id of User format: int32 nullable: true user_code: type: string description: User code. nullable: true first_name: type: string description: First name. nullable: true surname: type: string description: Surname. nullable: true additionalProperties: false description: Credit Note User ```