Skip to main content
PATCH
/
invoice
/
{invoiceId}
cURL
curl --request PATCH \
  --url https://api.slash.com/invoice/{invoiceId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "accountId": "<string>",
  "details": {
    "issuedAt": "2023-11-07T05:31:56Z",
    "dueAt": "2023-11-07T05:31:56Z",
    "invoiceTz": "America/New_York",
    "lineItemsAndTotals": {
      "lineItems": [
        {
          "name": "<string>",
          "quantity": 123,
          "priceCents": 123
        }
      ],
      "discount": {
        "type": "percentage",
        "percent": 123
      },
      "tax": {
        "type": "percentage",
        "percent": 123
      }
    },
    "invoiceNumber": "<string>",
    "memo": "<string>",
    "version": 2,
    "ccEmails": [
      "<string>"
    ]
  },
  "paymentMethods": [
    {
      "method": "inbound_ach_transfer",
      "config": {
        "passFeeToPayer": true
      }
    }
  ],
  "autoPullEnabled": true
}
'
{
  "invoice": {
    "id": "<string>",
    "status": "void",
    "collectedAmountCents": 123,
    "invoiceDetailsId": "<string>",
    "accountId": "<string>",
    "legalEntityContactId": "<string>",
    "invoiceTransactions": [
      {
        "transactionType": "external",
        "transaction": {
          "paymentMethod": "inbound_ach_transfer",
          "paidAt": "<string>"
        }
      }
    ],
    "invoicePaymentMethods": [
      {
        "method": "inbound_ach_transfer",
        "config": {
          "passFeeToPayer": true
        }
      }
    ],
    "closedAt": "2023-11-07T05:31:56Z"
  },
  "invoiceDetails": {
    "id": "<string>",
    "issuedAt": "2023-11-07T05:31:56Z",
    "dueAt": "2023-11-07T05:31:56Z",
    "invoiceTz": "America/New_York",
    "currency": "<string>",
    "lineItemsAndTotals": {
      "lineItems": [
        {
          "name": "<string>",
          "quantity": 123,
          "priceCents": 123
        }
      ],
      "subtotalCents": 123,
      "totalAmountCents": 123,
      "discount": {
        "type": "percentage",
        "percent": 123
      },
      "tax": {
        "type": "percentage",
        "percent": 123
      }
    },
    "invoiceNumber": "<string>",
    "documentId": "<string>",
    "billedTo": {
      "name": "<string>",
      "email": "<string>",
      "address": {
        "addressLine": "<string>",
        "addressCity": "<string>",
        "addressState": "<string>",
        "addressZip": "<string>",
        "addressLine2": "<string>",
        "addressCountry": "<string>"
      },
      "ccEmails": [
        "<string>"
      ]
    },
    "version": 2,
    "memo": "<string>"
  },
  "invoiceAccount": {
    "id": "<string>",
    "name": "<string>",
    "slashAccountGroupId": "<string>",
    "accountType": "default",
    "accountNumber": "<string>",
    "routingNumber": "<string>",
    "closedAt": "<string>"
  }
}

Authorizations

X-API-Key
string
header
required

Authentication from public API requests

Path Parameters

invoiceId
string
required

Body

application/json
accountId
string

The ID of the account to receive payment.

details
InvoiceDetailsInput · object
paymentMethods
InvoiceSlashPaymentMethod · object[]

Payment methods to enable on this invoice.

autoPullEnabled
boolean

Whether to automatically pull payment via ACH debit when the payer has authorized recurring debits.

Response

OK

Aggregate model for an invoice

invoice
Invoice · object
required

Top-level invoice model

invoiceDetails
InvoiceDetails · object
required
invoiceAccount
Model · object
required