Create an invoice

POST

https://api-sandbox.synswi.com/v1/invoices

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

Example


{   
    "accountId": "{{accountId}}",
    "sender": {
        "name": "Synswi"
    },
    "recipient": {
        "email": "lx864079393@gmail.com",
        "name": "Xiang Li"
    },
    "items": [
        {"name": "development", "quantity": 20, "unitPrice": 50},
        {"name": "service charge", "quantity": 2, "unitPrice": 300}

    ],
    "contactEmail": "richyyu1003@gmail.com",
    "allowedPaymentMethods": [],
    "cardPaymentOptions": {
        "surchargeAmount": 0
    },
    "tags": {
        "ok": "1"
    },
    "taxAmount": 0,
    "taxRate":300,
    "totalAmount": 700
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api-sandbox.synswi.com/v1/invoices' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{   
    "accountId": "acc-c068c34e-b12d-48b1-bc5f-c85edag8tgiut",
    "sender": {
        "name": "Synswi"
    },
    "recipient": {
        "email": "lx864079393@gmail.com",
        "name": "Xiang Li"
    },
    "items": [
        {"name": "development", "quantity": 20, "unitPrice": 50},
        {"name": "service charge", "quantity": 2, "unitPrice": 300}

    ],
    "contactEmail": "richyyu1003@gmail.com",
    "allowedPaymentMethods": [],
    "cardPaymentOptions": {
        "surchargeAmount": 0
    },
    "tags": {
        "ok": "1"
    },
    "taxAmount": 0,
    "taxRate":300,
    "totalAmount": 700
}'

Responses

🟢200Success

application/json

Body

Example

{
    "id": "string",
    "status": "created"
}

Get invoices

Pay an invoice