Synswi
  1. Invoice
Synswi
  • Invoice
    • Get invoice by id
      GET
    • Get invoices
      GET
    • Create an invoice
      POST
    • Pay an invoice
      POST
    • Send Invoice
      POST
    • Update an invoice
      POST
  • Payment instruments
    • Create a payment instrument
    • Get payment instruments
      GET
    • Get a payment instrument by id
      GET
  • Transactions
    • Get a transaction by id
      GET
    • Get transactions
      GET
    • Create a transaction
      POST
  1. Invoice

Update an invoice

POST
https://api-sandbox.synswi.com/v1/ivoices/update

Request

Body Params application/json
invoiceId
string 
required
recipient
object 
required
name
string 
required
email
string 
required
items
array[string]
required
allowedPaymentMethods
array[string]
required
cardPaymentOptions
object 
required
taxRate
integer 
required
taxAmount
integer 
required
status
string 
required
Example
{
    "invoiceId": "string",
    "recipient": {
        "name": "string",
        "email": "string"
    },
    "items": [
        "string"
    ],
    "allowedPaymentMethods": [
        "string"
    ],
    "cardPaymentOptions": {},
    "taxRate": 0,
    "taxAmount": 0,
    "status": "string"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api-sandbox.synswi.com/v1/ivoices/update' \
--header 'Content-Type: application/json' \
--data-raw '{
    "invoiceId": "string",
    "recipient": {
        "name": "string",
        "email": "string"
    },
    "items": [
        "string"
    ],
    "allowedPaymentMethods": [
        "string"
    ],
    "cardPaymentOptions": {},
    "taxRate": 0,
    "taxAmount": 0,
    "status": "string"
}'

Responses

🟢200Success
application/json
Body
object {0}
Example
{}
Previous
Send Invoice
Next
Create a payment instrument
Built with