Class InvoicePaymentsAPI

constructor

• new InvoicePaymentsAPI(httpRequest): InvoicePaymentsAPI

• Parameters

  • httpRequest: BaseHttpRequest

  Returns InvoicePaymentsAPI

Readonly httpRequest

getPayments

• getPayments(__namedParameters): CancelablePromise<GetInvoicePaymentsResponse>

• Get payments for invoice Retrieves all payments recorded for a specific invoice

  Parameters

  • __namedParameters: {
        companyId: string;
        invoiceId: string;
    }

    • companyId: string

      Company ID the invoice belongs to

    • invoiceId: string

      ID of the invoice to get payments for

  Returns CancelablePromise<GetInvoicePaymentsResponse>

  GetInvoicePaymentsResponse

  Throws

  ApiError

recordPayment

• recordPayment(__namedParameters): CancelablePromise<RecordPaymentResponse>

• Record payment for invoice Records a payment made for a specific invoice

  Parameters

  • __namedParameters: {
        companyId: string;
        invoiceId: string;
        requestBody: RecordPaymentRequestBody;
    }

    • companyId: string

      Company ID the invoice belongs to

    • invoiceId: string

      ID of the invoice to record payment for

    • requestBody: RecordPaymentRequestBody

  Returns CancelablePromise<RecordPaymentResponse>

  RecordPaymentResponse

  Throws

  ApiError