invoices

Get invoice

Get an invoice by ID

get/invoices/{id}

Request

  • Base URL: https://api.agentpaid.io/api/v2
  • URL: https://api.agentpaid.io/api/v2/invoices/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Response

200

idstring required
displayNumberstring nullable
orderIdstring nullable
customerIdstring required
status'building' | 'draft' | 'pending' | 'posted' | 'voided' | 'canceled' | 'error' required
paymentStatus'pending' | 'paid' | 'partiallyPaid' | 'overdue' | 'error' required
source'order_based' | 'manual' required
startDatestring date-time required
endDatestring date-time nullable
issueDatestring date-time required
postedDatestring date-time nullable
dueDatestring date-time nullable
currencystring required
taxAmountnumber double required
taxRatenumber double required
taxStatus'not_applicable' | 'calculated' | 'committed' | 'failed' | 'voided' required
invoiceTotalExcludingTaxnumber double required
invoiceTotalnumber double required
amountDuenumber double required
amountPaidnumber double required
amountRemainingnumber double required
creditNotesTotalnumber double required
metadataobject nullable
createdAtstring date-time required
updatedAtstring date-time required
paymentLinkstring nullable
disputeLinkstring nullable

Always null. The disputes feature is removed. Will be removed in a future API version.

publicUrlTokenstring nullable
taxExemptboolean required
billingContactIdstring nullable
purchaseOrderReferencestring nullable

Purchase order reference stamped on this invoice.

Changes

No recorded changes to this operation across all 1 revision of this API.