Add New Credit Note

Production

https://{{subdomain}}.daftra.com/api2

POST

/credit_notes{format}

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://.daftra.com/api2/credit_notes' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--header 'apikey: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "CreditNote": {
        "staff_id": 0,
        "subscription_id": null,
        "store_id": 0,
        "no": "0700000AAAAA0001",
        "po_number": 26,
        "name": "string",
        "client_id": 15,
        "is_offline": true,
        "currency_code": "USD",
        "client_business_name": "Example Client",
        "client_first_name": "Example",
        "client_last_name": "Client",
        "client_email": "client@example.com",
        "client_address1": "string",
        "client_address2": "string",
        "client_postal_code": "string",
        "client_city": "string",
        "client_state": "string",
        "client_country_code": "EG",
        "date": "2018-11-07",
        "draft": "0",
        "discount": 0,
        "discount_amount": 0,
        "deposit": 0,
        "deposit_type": 0,
        "notes": "string",
        "html_notes": "string",
        "invoice_layout_id": 1,
        "estimate_id": "The primary store id",
        "shipping_options": "",
        "shipping_amount": null,
        "client_active_secondary_address": true,
        "client_secondary_name": "string",
        "client_secondary_address1": "string",
        "client_secondary_address2": "string",
        "client_secondary_city": "string",
        "client_secondary_state": "string",
        "client_secondary_postal_code": "string",
        "client_secondary_country_code": "string",
        "follow_up_status": null,
        "work_order_id": null,
        "requisition_delivery_status": null,
        "pos_shift_id": null,
        "qr_code_url": "https://yoursite.daftra.com/qr/?d64=QVE1TmIyaGhiV1ZrSUVGemFISmhaZ0lJTVRFMU16WTJRMUlERkRJd01qSXRNVEF0TWpoVU1EQTZNREU2TVRWYUJBRXdCUUV3",
        "invoice_html_url": "https://yoursite.daftra.com/invoices/preview/2621?hash=c06543fe13bd4850b521733687c53259",
        "invoice_pdf_url": "https://yoursite.daftra.com/invoices/view/2621.pdf?hash=c06543fe13bd4850b521733687c53259"
    },
    "InvoiceItem": [
        {
            "invoice_id": 0,
            "item": "string",
            "description": "string",
            "unit_price": 0,
            "quantity": 0,
            "tax1": 0,
            "tax2": 0,
            "product_id": 0,
            "col_3": null,
            "col_4": null,
            "col_5": null,
            "discount": 0,
            "discount_type": "1 => Percentage",
            "store_id": "The invoice store id"
        }
    ],
    "InvoicePayment": [
        {
            "invoice_id": 0,
            "payment_method": "string",
            "amount": 0,
            "transaction_id": "string",
            "treasury_id": 0,
            "date": "2019-08-24T14:15:22Z",
            "email": "string",
            "status": 0,
            "notes": "string",
            "response_code": "string",
            "response_message": "string",
            "created": "2019-08-24T14:15:22Z",
            "modified": "2019-08-24T14:15:22Z",
            "currency_code": "str",
            "first_name": "string",
            "last_name": "string",
            "address1": "string",
            "address2": "string",
            "city": "string",
            "state": "string",
            "postal_code": "string",
            "country_code": "str",
            "phone1": "string",
            "phone2": "string",
            "transaction_type": "string",
            "processed": true,
            "attachment": "string",
            "staff_id": 0,
            "receipt_notes": "string"
        }
    ],
    "InvoiceCustomField": {},
    "Deposit": {},
    "InvoiceReminder": {},
    "Document": {},
    "DocumentTitle": {}
}'

Response Example

202 - Example 1

{
    "code": 202,
    "result": "successful",
    "id": "2415"
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢202Accepted

application/json

Created

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Delete Credit Notes

GET All Refund Receipts