Contractors.es icon

Contractors.es

Interact with Contractors.es API

Actions995

Invoice Api → Post Api Contractors Invoices

AI-generated

Summary

Create a new invoice in the Contractors.es system by submitting invoice details via the API.

Inputs

  • Include — Optional comma-separated list of related entities to include in the response. Possible values are 'project', 'projectStage', and 'finalInvoice'.
  • Project Id — The ID of the project associated with the invoice.
  • Project Stage Id — The ID of the project stage associated with the invoice.
  • Type — The type of invoice. Options are 'partial', 'prepayment', or 'final'.
  • Invoice No — The invoice number.
  • Date — The date of the invoice.
  • Due Date — The due date for the invoice payment.
  • Description — Description or details about the invoice.
  • Footer — Footer text to appear on the invoice.
  • Tax Rates — Tax rates applied to the invoice, provided as a JSON object.
  • Amount — The total amount of the invoice.
  • Amount Currency — Currency code corresponding to the 'Amount' field.
  • Order Amount — The order amount for the invoice.
  • Order Amount Currency — Currency code corresponding to the 'Order Amount'.
  • Paid Amount — Amount already paid on the invoice.
  • Document Paid Amount — Paid amount documented for the invoice.
  • Document Paid Amount Currency — Currency code for the 'Document Paid Amount'.
  • Paid Amount Currency — Currency code for the 'Paid Amount'.
  • Paid In Full — Indicates if the invoice has been paid in full.
  • Paid In Full Date — Date when the invoice was fully paid.
  • Update Progress — Flag indicating if progress should be updated based on the invoice.
  • Job Progress — Current job progress percentage related to the invoice.
  • External Id — External identifier for integration purposes.
  • Prepayment Ids — JSON array of prepayment invoice IDs; must be provided when invoice type is 'final' and must be omitted otherwise.

Output shape

a single record containing the newly created invoice data

The response includes the details of the created invoice. The 'include' query parameter controls which related entities are expanded in the response. Optional fields in the request default to being ignored if set to sentinel values like 'DO_NOT_SET'.

Links

Discussion