Skip to main content
GuidesAPI Reference

Update Invoice

PUT 
/accounting/invoices/:id

Updates an invoice with the given id.

Request​

Path Parameters

    id stringrequired

    The ID of the invoice.

Query Parameters

    credentialId stringrequired

    The ID of the credential.

Header Parameters

    Authorization stringrequired

    Default value: bearer YOUR_API_KEY

Body

    customerId string

    The ID of the customer associated with the invoice.

    lineItems

    object

    required

    Detailed breakdown of all the goods or services billed in the invoice, including descriptions, quantities, and prices.

    description stringrequired

    A concise overview or detail of the specific good or service listed in the line item.

    unitPrice float

    The cost assigned per individual unit of the good or service.

    quantity int32

    The number of units of the particular good or service being invoiced.

    totalAmount stringrequired

    The cumulative sum for the line item, typically calculated as unitPrice * quantity.

    accountingItemId string

    The ID of the item associated with the invoice line item.

    accountId string

    The ID of the account associated with the invoice line item.

    invoiceNumber string

    A unique number or code assigned to the invoice for easy reference.

    issueDate string

    The date when the invoice was generated and sent to the customer. Format: YYYY-MM-DD

    dueDate string

    The date by which the payment for the invoice is expected. Format: YYYY-MM-DD

    memo string

    Any supplementary notes, comments, or details related to the invoice.

    currency string

    The type of currency in which the invoice amount is presented. Possible values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UYW, UZS, VES, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWL

    exchangeRate float

    The conversion rate used if the invoice involves transactions in foreign currency.

    totalAmount float

    The complete sum due, after considering all charges, taxes, and discounts.

    balance float

    The outstanding amount remaining to be paid, after any partial payments or credits.

    remoteFields json

    An object containing remote fields that are not supported by the common model. The keys are the names of the fields of the corresponding resource in the remote app, and the values can be strings, numbers, arrays or objects.

Responses​

200

Schema

    invoice

    object

    remoteId string
    customerId
    invoiceNumber string
    issueDate integer

    Default value: 0

    dueDate integer

    Default value: 0

    paidOnDate
    memo
    companyId
    currency string
    exchangeRate
    totalDiscount string
    subTotal string
    invoiceStatus
    totalTaxAmount
    totalAmount number

    Default value: 0

    balance number

    Default value: 0

    trackingCategories array

    lineItems

    object[]

  • Array [

    • id
    remoteId
    description string
    unitPrice
    quantity
    totalAmount number

    Default value: 0

    currency string
    exchangeRate
    accountingItemId
    accountId
    trackingCategoryId
    trackingCategoryIds array
    companyId

  • ]

    • purchaseOrders array
    id string
    remoteCreatedAt string
    remoteUpdatedAt string
    remoteDeleted boolean

    Default value: true

    createdAt string
    updatedAt string
Loading...