Skip to content
Baack
Book a stack auditBook an audit
Menu

Payment Invoice

Representation of a payment invoice

Browse the docs

Endpoints

  • GET/n/v1/paymentinvoice/{urn}

    Endpoint for managing payment invoices, both payable and receivable

    Parameters

    urn (path, required)
    String representation of a Unique Resource Name. Typically a UUID with 36 characters.

    Responses

    200 OK
    returns Payment InvoiceREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
  https://api.baack.co/n/v1/paymentinvoice/{urn}

Fields

Payment Invoice fields
FieldTypeDescription
ownerCompany

Required on create.

remitterRemitter
identifiersarray of Payment Invoice Identifier

Ignored on update.

discountstring
taxstring
subTotalstring
fullyPaidTimestampstring (date-time)
updatedTimestampstring (date-time)
urlstring (uri)
urnstring (uuid)
lineItemTaxstring

One of: EXCLUSIVE, INCLUSIVE, NO_TAX

totalstring
paidstring
recipientRecipient
issuedTimestampstring (date-time)
refundedstring
linesarray of Payment Invoice Line

Ignored on update.

dueTimestampstring (date-time)
currencyCodestring

One of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BYR, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EEK, 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, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, 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, SKK, SLE, SLL, SOS, SRD, STN, STD, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZMK, ZWD

statusstring

One of: DRAFT, IN_REVIEW, AUTHORISED, PENDING, VOIDED, PAID, REFUNDED

Used by: Message Thread

Payment Invoice Identifier

Payment invoice identifier e.g. invoice ID

Fields

Payment Invoice Identifier fields
FieldTypeDescription
urnstring (uuid)
domainstring
tokenstring

Used by: Payment Invoice

Payment Invoice Line

Payment invoice line item

Fields

Payment Invoice Line fields
FieldTypeDescription
urnstring (uuid)
unitPricenumber (double)
discountRatenumber (double)
quantitynumber (double)
pricestring
itemCodestring

Up to 256 characters.

discountPricestring
descriptionstring

Up to 4096 characters.

taxstring
taxabilitystring

One of: TAXABLE, NON_TAXABLE, TAX_EXEMPT, PARTIALLY_TAXABLE, NOT_APPLICABLE

lineNumberinteger (int32)
taxNamestring

Used by: Payment Invoice

Recipient

The recipient representation is used to model a payment invoice recipient either as a company or identity.

Fields

Recipient fields
FieldTypeDescription
identityIdentity
companyCompany

Used by: Payment Invoice

Remitter

The remitter or payee is the company or identity which is making the payment in the context of a payment or invoice

Fields

Remitter fields
FieldTypeDescription
identityIdentity
companyCompany

Used by: Payment Invoice