# Invoices

Invoices

## Returns the default invoice template

 - [GET /invoices/defaultTemplate/invoice](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/getdefaultinvoicetemplate.md): Returns the default invoice template

## Returns the default invoice template

 - [GET /invoices/defaultTemplateAndEmail/invoice](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/getdefaultinvoicetemplateandemail.md): Returns the default invoice template

## Initiates workflow to warm up inventory transactions

 - [POST /invoices/warmUpStepFunctions](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/warmupstepfunctions.md)

## Creates a new invoice record that does not already exist.

 - [POST /invoices/{tenantId}](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/processinvoice.md): This method will auto-generate an ID and create a new invoice. If an ID is specified for the invoice, an error will be thrown.

## Processes an invoice adjustment for the invoice with the specified ID

 - [PUT /invoices/{tenantId}/adjustment/sync/{id}](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/adjustinvoiceamountssync.md): This method will start an workflow to adjust an invoice, returning an execution token.

## Processes an invoice adjustment for the invoice with the specified ID

 - [PUT /invoices/{tenantId}/adjustment/{id}](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/adjustinvoiceamounts.md): This method will start an workflow to adjust an invoice, returning an execution token.

## Execute Batch Operations

 - [POST /invoices/{tenantId}/batch](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/executebatchoperations.md): TAllows you to perform up to 100 parallel patch/delete operations

## Returns a list of records with the specified batch_id

 - [GET /invoices/{tenantId}/batch/{batch_id}](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/listinvoicesbybatchid.md): Returns a list of records with the specified batch_id

## Returns a list of records with the specified bill_to_contact_id

 - [GET /invoices/{tenantId}/billToContact/{bill_to_contact_id}](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/listinvoicesbybilltocontactid.md): Returns a list of records with the specified bill_to_contact_id

## Returns a list of records with the specified bill_to_organization_id

 - [GET /invoices/{tenantId}/billToOrganization/{bill_to_organization_id}](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/listinvoicesbybilltoorganizationid.md): Returns a list of records with the specified bill_to_organization_id

## Emails an HTML version of the invoice

 - [POST /invoices/{tenantId}/email/{id}](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/emailinvoice.md): Send an email of the invoice

## Returns a list of records with the specified number

 - [GET /invoices/{tenantId}/number/{number}](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/listinvoicesbynumber.md): Returns a list of records with the specified number

## Returns a list of records with the specified order_id

 - [GET /invoices/{tenantId}/order/{order_id}](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/listinvoicesbyorderid.md): Returns a list of records with the specified order_id

## Returns a list of records with the specified owner

 - [GET /invoices/{tenantId}/owner/{ownerType}/{ownerId}](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/listinvoicesbyowner.md): Returns a list of records with the specified owner

## Gets the URL for public payment of the invoice

 - [GET /invoices/{tenantId}/paymentLink/{id}](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/getpublicpaymentlink.md): Returns a link that can be used to share an invoice and payable

## Gets all of the invoices in the system for a given contact.

 - [GET /invoices/{tenantId}/portal/contact/{portalContactId}](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/listinvoicesforportal.md): This method will scan all invoices and and return them to the caller for a given contact.

## Gets the amount of open invoices for a contact

 - [GET /invoices/{tenantId}/portal/contact/{portalContactId}/balance](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/getcontactbalance.md): Gets the amount of open invoices for a contact

## Returns a invoice from the system by its ID for a given contact.

 - [GET /invoices/{tenantId}/portal/contact/{portalContactId}/{id}](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/getinvoiceforportal.md): This method will look up a invoice by the specified ID and return it back (for a portal contact)

## Gets all of the invoices in the system for a given organization.

 - [GET /invoices/{tenantId}/portal/organization/{portalOrganizationId}](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/listinvoicesforportalbyorganization.md): This method will scan all invoices and and return them to the caller for a given organization.

## Gets the amount of open invoices for a organization

 - [GET /invoices/{tenantId}/portal/organization/{portalOrganizationId}/balance](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/getorganizationbalance.md): Gets the amount of open invoices for a organization

## Returns a invoice from the system by its ID for a given organization.

 - [GET /invoices/{tenantId}/portal/organization/{portalOrganizationId}/{id}](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/getinvoiceforportal.md): This method will look up a invoice by the specified ID and return it back (for a portal organization)

## Sends out a preview of the CRC notification email

 - [POST /invoices/{tenantId}/previewEmail](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/previewemail.md): Sends out a preview of the CRC notification email

## Sends out a preview of the notification template

 - [POST /invoices/{tenantId}/previewTemplate](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/previewtemplate.md): Sends out a preview of the notification template

## Generates a PDF and returns the public link for download

 - [GET /invoices/{tenantId}/print/{id}](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/downloadpdf.md): Generates a PDF and returns the public link for download

## Gets Public Invoice information

 - [GET /invoices/{tenantId}/public/{id}](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/getinvoicepublicly.md): Public endpoint that allows for retrieval of invoice information, provided the accurate sharing secret is supplied

## Finds all legacy invoices with an open balance and regenerates them

 - [POST /invoices/{tenantId}/regenerateOpenInvoices/{business_unit_id}](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/regeneratelegacyopeninvoices.md): Finds all legacy invoices with an open balance and regenerates them

## Generates a PDF and returns the public link for download

 - [GET /invoices/{tenantId}/renderEmail/{id}](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/renderinvoiceemail.md): Generates a PDF and returns the public link for download

## Searches for invoices using predefined parameters

 - [POST /invoices/{tenantId}/search](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/searchforinvoices.md): Searches for invoices using predefined parameters

## This is a synchronous processing and should be used exclusively. The old way (via step function) is deprecated.

 - [POST /invoices/{tenantId}/sync](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/processinvoicesync.md): Processes an invoice

## Returns a invoice from the system by its ID.

 - [DELETE /invoices/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/deleteinvoice.md): This method will delete a invoice with the specified ID.

## Returns a invoice from the system by its ID.

 - [GET /invoices/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/getinvoice.md): This method will look up a invoice by the specified ID and return it back.

## Partially updates a invoice with the specified ID.

 - [PATCH /invoices/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/patchinvoice.md): This method will patch an existing invoice with the specified ID, using the HTTP PATCH specification.

## Updates a invoice with the specified ID.

 - [PUT /invoices/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/collect/collect-v1/invoices/updateinvoice.md): This method will update an existing invoice with the specified ID.