Invoice version v5.0

http://localhost

Invoice API

This documents the API calls that can be made to manage invoices

/invoice

post get

Manage Invoices

post

Post invoice. Only in case an acquisition unit has to be assigned to the invoice, it is required that user should have extra permission invoices.acquisitions-units-assignments.assign to create an Invoice.

get

Retrieve a list of invoice items.

Post invoice. Only in case an acquisition unit has to be assigned to the invoice, it is required that user should have extra permission invoices.acquisitions-units-assignments.assign to create an Invoice.

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "invoice",
  "javaName": "Invoice",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID of this invoice",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "accountingCode": {
      "description": "Number that represents the vendor is an external accounting system which may include details like \"Address code\" in it. This is the number as stated on the invoice",
      "type": "string"
    },
    "adjustments": {
      "description": "List of invoice level adjustments. The adjustments can be pro-rated which are defined at the invoice level, but are applied to the invoice lines. A generic example is a shipping fee which should be spread out across all of the invoice lines so that all funds involved pay some portion of the fee.",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "Adjustment",
        "properties": {
          "id": {
            "description": "UUID of this adjustment",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "adjustmentId": {
            "description": "UUID of the Invoice adjustment incase of prorated adjustments",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "description": {
            "description": "Displayed in invoice line as a name for the input",
            "type": "string"
          },
          "exportToAccounting": {
            "description": "Whether or not to show this adjustment in batchedVoucherLines",
            "type": "boolean",
            "default": false
          },
          "fundDistributions": {
            "description": "Fund distribution records from which this adjustment will be paid; only valid at invoice level",
            "id": "fundDistributions",
            "type": "array",
            "items": {
              "description": "fund distribution record",
              "type": "object",
              "$schema": "http://json-schema.org/draft-04/schema#",
              "properties": {
                "code": {
                  "description": "The code of the fund associated with this fund distribution",
                  "type": "string"
                },
                "encumbrance": {
                  "description": "UUID of encumbrance record associated with this fund distribution",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "fundId": {
                  "description": "UUID of the fund associated with this fund distribution",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "invoiceLineId": {
                  "description": "UUID of the invoice line associated with this fund distribution",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "distributionType": {
                  "description": "Percentage or amount type of the value property",
                  "type": "string",
                  "enum": [
                    "amount",
                    "percentage"
                  ],
                  "default": "percentage"
                },
                "expenseClassId": {
                  "description": "UUID of the expense class associated with this fund distribution",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "value": {
                  "description": "The percentage of the cost to be applied to this fund",
                  "type": "number"
                }
              },
              "additionalProperties": false,
              "required": [
                "fundId",
                "distributionType",
                "value"
              ]
            }
          },
          "prorate": {
            "description": "Displayed in invoice line per adjustment in toggled on in settings",
            "type": "string",
            "enum": [
              "By line",
              "By amount",
              "By quantity",
              "Not prorated"
            ],
            "default": "Not prorated"
          },
          "relationToTotal": {
            "description": "Relationship of this adjustment to the total;In addition to: added to subtotal;Included in: reported as subtotal portion;Separate from:calculated from subtotal",
            "type": "string",
            "enum": [
              "In addition to",
              "Included in",
              "Separate from"
            ],
            "default": "In addition to"
          },
          "type": {
            "description": "Adjustment type",
            "type": "string",
            "enum": [
              "Percentage",
              "Amount"
            ]
          },
          "value": {
            "description": "Adjustment value",
            "type": "number"
          },
          "totalAmount": {
            "description": "Total adjustment amount",
            "type": "number"
          }
        },
        "additionalProperties": false,
        "required": [
          "description",
          "exportToAccounting",
          "prorate",
          "relationToTotal",
          "type",
          "value"
        ]
      }
    },
    "adjustmentsTotal": {
      "description": "Total amount which is sum of all invoice line adjustments and all non-prorated invoice level adjustments. This amount is always calculated by system.",
      "type": "number"
    },
    "approvedBy": {
      "description": "UUID of user that approved this invoice",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "approvalDate": {
      "description": "Date the invoice was approved for processing",
      "type": "string",
      "format": "date-time"
    },
    "batchGroupId": {
      "description": "UUID of the batch group to use when generating batch vouchers",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
      "default": "2a2cb998-1437-41d1-88ad-01930aaeadd5"
    },
    "billTo": {
      "description": "UUID of the billing address",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "chkSubscriptionOverlap": {
      "description": "IF TRUE the system will check if there is another invoice for this subscription and whether the dates overlap. IF the dates overlap, the system should issue an alert.",
      "type": "boolean"
    },
    "cancellationNote": {
      "description": "The reason of the invoice cancellation.",
      "type": "string"
    },
    "currency": {
      "description": "Ideally this is the ISO code and not something the user defines",
      "type": "string"
    },
    "enclosureNeeded": {
      "description": "Indicates that an enclosure is needed",
      "type": "boolean",
      "default": false
    },
    "exchangeRate": {
      "description": "Exchange rate",
      "type": "number"
    },
    "operationMode": {
      "description": "Operation mode performed on the exchange rate",
      "type": "string"
    },
    "exportToAccounting": {
      "description": "This would keep the invoice from being feed into the batch process (i.e. not generate an external voucher/payment) but would still move values in the system. This might be defined by the vendor relationship and exposed for override on the invoice.",
      "type": "boolean",
      "default": false
    },
    "folioInvoiceNo": {
      "description": "Invoice number in folio system",
      "type": "string"
    },
    "invoiceDate": {
      "description": "Invoice date",
      "type": "string",
      "format": "date-time"
    },
    "lockTotal": {
      "description": "Total amount which manually set by user. The calculated total must match this before the invoice can be approved",
      "type": "number"
    },
    "note": {
      "description": "Invoice note",
      "type": "string"
    },
    "paymentDue": {
      "description": "When this is required to be paid. Generally governed by the relationship with the Vendor",
      "type": "string",
      "format": "date-time"
    },
    "paymentDate": {
      "description": "When the invoice was actually paid",
      "type": "string",
      "format": "date-time"
    },
    "paymentTerms": {
      "description": "Invoice payment terms",
      "type": "string"
    },
    "paymentMethod": {
      "description": "Inherited from vendor record",
      "type": "string"
    },
    "status": {
      "description": "Open: Record has been created, Reviewed: details have been verified, Approved: Funds are release, Paid: confirmation that funds have been exchanged and check number has been returned amounts are frozen, cancelled.\nNote: invoices are never partially paid.",
      "type": "string",
      "enum": [
        "Open",
        "Reviewed",
        "Approved",
        "Paid",
        "Cancelled"
      ]
    },
    "source": {
      "description": "This does not denote a user ID but describes how the record was created. Eg. User, API, EDI",
      "type": "string",
      "enum": [
        "User",
        "API",
        "EDI"
      ]
    },
    "subTotal": {
      "description": "Invoice amount before adjustments are applied. This is sum of all subTotal amounts of the corresponding invoice lines. This amount is always calculated by system.",
      "type": "number",
      "readonly": true
    },
    "total": {
      "description": "The total amount is calculated \"on the fly\" of this invoice which is sum of subTotal and adjustmentsTotal. Must be the same with existed \"lockTotal\", when approve invoice.",
      "type": "number",
      "readonly": true
    },
    "vendorInvoiceNo": {
      "description": "This is the number from the vendor's invoice, which is different from the folioInvoiceNo",
      "type": "string"
    },
    "disbursementNumber": {
      "description": "The identifier for the physical transaction corresponding to a payment (Eg. Check #, EFT # etc.) Brought in from external source",
      "type": "string"
    },
    "voucherNumber": {
      "description": "Number generated by folio that will eventually identify the payment request sent out to external financial system.",
      "type": "string"
    },
    "paymentId": {
      "description": "Id of payment",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "disbursementDate": {
      "description": "Date payment was made from financial system (eg. corresponding check date)",
      "type": "string",
      "format": "date-time"
    },
    "poNumbers": {
      "description": "May or may not be provided; references the PO associated to the invoice",
      "id": "poNumbers",
      "type": "array",
      "items": {
        "description": "A human readable ID assigned to this purchase order",
        "type": "string",
        "pattern": "^[a-zA-Z0-9]{1,22}$"
      }
    },
    "vendorId": {
      "description": "UUID of vendor",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "fiscalYearId": {
      "description": "UUID of fiscal year",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "accountNo": {
      "description": "The unique number of the organization account",
      "type": "string"
    },
    "manualPayment": {
      "description": "This would keep the invoice from being feed into the batch process (Not generate a external voucher/payment) but would still move values in the system. Note: this is ideally defined by the vendor relationship and exposed for override on the invoice.",
      "type": "boolean"
    },
    "acqUnitIds": {
      "description": "acquisition unit ids associated with this invoice",
      "type": "array",
      "items": {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "The UUID format string",
        "type": "string",
        "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
      }
    },
    "nextInvoiceLineNumber": {
      "description": "Number that will be used next time an invoice line is created",
      "type": "integer",
      "readonly": true
    },
    "metadata": {
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    },
    "tags": {
      "type": "object",
      "description": "arbitrary tags associated with this invoice",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "tags.schema",
      "title": "tags",
      "properties": {
        "tagList": {
          "description": "List of tags",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false,
  "required": [
    "batchGroupId",
    "currency",
    "invoiceDate",
    "paymentMethod",
    "status",
    "source",
    "vendorInvoiceNo",
    "vendorId"
  ]
}

Example:

{
  "id": "733cafd3-895f-4e33-87b7-bf40dc3c8069",
  "accountingCode" : "0206",
  "adjustments": [
    {
      "id": "14263aab-b22b-4ddc-9ecc-3434427c2c8f",
      "description": "Shipping",
      "exportToAccounting" : false,
      "type": "Amount",
      "value": 4.50,
      "prorate": "By line",
      "relationToTotal": "In addition to"
    },
    {
      "description": "Some Tax",
      "exportToAccounting" : false,
      "fundDistributions": [
        {
          "code": "USHIST",
          "encumbrance": "1c8fc9f4-d2cc-4bd1-aa9a-cb02291cbe65",
          "fundId": "1d1574f1-9196-4a57-8d1f-3b2e4309eb81",
          "distributionType": "percentage",
          "value": 100
        }
      ],
      "type": "Amount",
      "value": 10,
      "prorate": "Not prorated",
      "relationToTotal": "In addition to"
    }
  ],
  "adjustmentsTotal": 14.50,
  "batchGroupId": "2a2cb998-1437-41d1-88ad-01930aaeadd5",
  "chkSubscriptionOverlap": false,
  "currency": "USD",
  "enclosureNeeded" : false,
  "exchangeRate" : 1.092,
  "operationMode": "MULTIPLY",
  "exportToAccounting": true,
  "folioInvoiceNo": "123invoicenumber45",
  "invoiceDate": "2018-07-20T00:00:00.000+0000",
  "lockTotal": 64.50,
  "note": "Some note",
  "paymentDue": "2018-08-29T00:00:00.000+0000",
  "paymentDate": "2018-08-29T00:10:00.000+0000",
  "paymentTerms": "Payment in Advance",
  "paymentMethod": "EFT",
  "status": "Reviewed",
  "source": "User",
  "vendorInvoiceNo": "YK75851",
  "disbursementNumber": "58",
  "voucherNumber": "478",
  "paymentId": "a5065f0d-fb88-4d23-b0c1-57e754fba40e",
  "disbursementDate": "2018-08-19T00:00:00.000+0000",
  "poNumbers": [
    "AB268758XYZ"
  ],
  "vendorId": "168f8a63-d612-406e-813f-c7527f241ac3",
  "fiscalYearId": "ac2164c7-ba3d-1bc2-a12c-e35ceccbfaf2",
  "accountNo": "GOBI-HIST-12",
  "manualPayment": true,
  "nextInvoiceLineNumber": 1,
  "tags": {
    "tagList": [
      "tag"
    ]
   },
  "acqUnitIds": [
    "1895e539-8dac-441e-b1f5-aab62b3fde60",
    "47f504bd-0c1b-498e-a2ae-e2f0a0cea273"
  ],
  "metadata": {
    "createdDate": "2018-07-19T00:00:00.000+0000",
    "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
  }
}

HTTP status code 201

Returns a newly created item, with server-controlled fields like 'id' populated

Headers

  • Location: required(string)

    URI to the created invoice item

Body

Media type: application/json

Type: any

Example:

{
  "id": "733cafd3-895f-4e33-87b7-bf40dc3c8069",
  "accountingCode" : "0206",
  "adjustments": [
    {
      "id": "14263aab-b22b-4ddc-9ecc-3434427c2c8f",
      "description": "Shipping",
      "exportToAccounting" : false,
      "type": "Amount",
      "value": 4.50,
      "prorate": "By line",
      "relationToTotal": "In addition to"
    },
    {
      "description": "Some Tax",
      "exportToAccounting" : false,
      "fundDistributions": [
        {
          "code": "USHIST",
          "encumbrance": "1c8fc9f4-d2cc-4bd1-aa9a-cb02291cbe65",
          "fundId": "1d1574f1-9196-4a57-8d1f-3b2e4309eb81",
          "distributionType": "percentage",
          "value": 100
        }
      ],
      "type": "Amount",
      "value": 10,
      "prorate": "Not prorated",
      "relationToTotal": "In addition to"
    }
  ],
  "adjustmentsTotal": 14.50,
  "batchGroupId": "2a2cb998-1437-41d1-88ad-01930aaeadd5",
  "chkSubscriptionOverlap": false,
  "currency": "USD",
  "enclosureNeeded" : false,
  "exchangeRate" : 1.092,
  "operationMode": "MULTIPLY",
  "exportToAccounting": true,
  "folioInvoiceNo": "123invoicenumber45",
  "invoiceDate": "2018-07-20T00:00:00.000+0000",
  "lockTotal": 64.50,
  "note": "Some note",
  "paymentDue": "2018-08-29T00:00:00.000+0000",
  "paymentDate": "2018-08-29T00:10:00.000+0000",
  "paymentTerms": "Payment in Advance",
  "paymentMethod": "EFT",
  "status": "Reviewed",
  "source": "User",
  "vendorInvoiceNo": "YK75851",
  "disbursementNumber": "58",
  "voucherNumber": "478",
  "paymentId": "a5065f0d-fb88-4d23-b0c1-57e754fba40e",
  "disbursementDate": "2018-08-19T00:00:00.000+0000",
  "poNumbers": [
    "AB268758XYZ"
  ],
  "vendorId": "168f8a63-d612-406e-813f-c7527f241ac3",
  "fiscalYearId": "ac2164c7-ba3d-1bc2-a12c-e35ceccbfaf2",
  "accountNo": "GOBI-HIST-12",
  "manualPayment": true,
  "nextInvoiceLineNumber": 1,
  "tags": {
    "tagList": [
      "tag"
    ]
   },
  "acqUnitIds": [
    "1895e539-8dac-441e-b1f5-aab62b3fde60",
    "47f504bd-0c1b-498e-a2ae-e2f0a0cea273"
  ],
  "metadata": {
    "createdDate": "2018-07-19T00:00:00.000+0000",
    "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
  }
}

HTTP status code 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

"unable to add invoice -- malformed JSON at 13:3"

HTTP status code 401

Not authorized to perform requested action

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

unable to create invoices -- unauthorized

HTTP status code 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "errors.schema",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "error.schema",
        "description": "An error",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message text"
          },
          "type": {
            "type": "string",
            "description": "Error message type"
          },
          "code": {
            "type": "string",
            "description": "Error message code"
          },
          "parameters": {
            "description": "Error message parameters",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "parameters.schema",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "total_records": {
      "description": "Total number of errors",
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

get put delete

Get, Delete or Update a specific invoice

get

Return an invoice with given {id}

put

Update invoice. Only in case an acquisition units list has to be changed, it is required that user should have extra permission invoices.acquisitions-units-assignments.manage to update an Invoice.

delete

Delete an invoice with given {id}

Return an invoice with given {id}

URI Parameters

  • id: required(string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)

    The UUID of an invoice

HTTP status code 200

Returns item with a given ID

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "invoice",
  "javaName": "Invoice",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID of this invoice",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "accountingCode": {
      "description": "Number that represents the vendor is an external accounting system which may include details like \"Address code\" in it. This is the number as stated on the invoice",
      "type": "string"
    },
    "adjustments": {
      "description": "List of invoice level adjustments. The adjustments can be pro-rated which are defined at the invoice level, but are applied to the invoice lines. A generic example is a shipping fee which should be spread out across all of the invoice lines so that all funds involved pay some portion of the fee.",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "Adjustment",
        "properties": {
          "id": {
            "description": "UUID of this adjustment",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "adjustmentId": {
            "description": "UUID of the Invoice adjustment incase of prorated adjustments",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "description": {
            "description": "Displayed in invoice line as a name for the input",
            "type": "string"
          },
          "exportToAccounting": {
            "description": "Whether or not to show this adjustment in batchedVoucherLines",
            "type": "boolean",
            "default": false
          },
          "fundDistributions": {
            "description": "Fund distribution records from which this adjustment will be paid; only valid at invoice level",
            "id": "fundDistributions",
            "type": "array",
            "items": {
              "description": "fund distribution record",
              "type": "object",
              "$schema": "http://json-schema.org/draft-04/schema#",
              "properties": {
                "code": {
                  "description": "The code of the fund associated with this fund distribution",
                  "type": "string"
                },
                "encumbrance": {
                  "description": "UUID of encumbrance record associated with this fund distribution",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "fundId": {
                  "description": "UUID of the fund associated with this fund distribution",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "invoiceLineId": {
                  "description": "UUID of the invoice line associated with this fund distribution",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "distributionType": {
                  "description": "Percentage or amount type of the value property",
                  "type": "string",
                  "enum": [
                    "amount",
                    "percentage"
                  ],
                  "default": "percentage"
                },
                "expenseClassId": {
                  "description": "UUID of the expense class associated with this fund distribution",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "value": {
                  "description": "The percentage of the cost to be applied to this fund",
                  "type": "number"
                }
              },
              "additionalProperties": false,
              "required": [
                "fundId",
                "distributionType",
                "value"
              ]
            }
          },
          "prorate": {
            "description": "Displayed in invoice line per adjustment in toggled on in settings",
            "type": "string",
            "enum": [
              "By line",
              "By amount",
              "By quantity",
              "Not prorated"
            ],
            "default": "Not prorated"
          },
          "relationToTotal": {
            "description": "Relationship of this adjustment to the total;In addition to: added to subtotal;Included in: reported as subtotal portion;Separate from:calculated from subtotal",
            "type": "string",
            "enum": [
              "In addition to",
              "Included in",
              "Separate from"
            ],
            "default": "In addition to"
          },
          "type": {
            "description": "Adjustment type",
            "type": "string",
            "enum": [
              "Percentage",
              "Amount"
            ]
          },
          "value": {
            "description": "Adjustment value",
            "type": "number"
          },
          "totalAmount": {
            "description": "Total adjustment amount",
            "type": "number"
          }
        },
        "additionalProperties": false,
        "required": [
          "description",
          "exportToAccounting",
          "prorate",
          "relationToTotal",
          "type",
          "value"
        ]
      }
    },
    "adjustmentsTotal": {
      "description": "Total amount which is sum of all invoice line adjustments and all non-prorated invoice level adjustments. This amount is always calculated by system.",
      "type": "number"
    },
    "approvedBy": {
      "description": "UUID of user that approved this invoice",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "approvalDate": {
      "description": "Date the invoice was approved for processing",
      "type": "string",
      "format": "date-time"
    },
    "batchGroupId": {
      "description": "UUID of the batch group to use when generating batch vouchers",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
      "default": "2a2cb998-1437-41d1-88ad-01930aaeadd5"
    },
    "billTo": {
      "description": "UUID of the billing address",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "chkSubscriptionOverlap": {
      "description": "IF TRUE the system will check if there is another invoice for this subscription and whether the dates overlap. IF the dates overlap, the system should issue an alert.",
      "type": "boolean"
    },
    "cancellationNote": {
      "description": "The reason of the invoice cancellation.",
      "type": "string"
    },
    "currency": {
      "description": "Ideally this is the ISO code and not something the user defines",
      "type": "string"
    },
    "enclosureNeeded": {
      "description": "Indicates that an enclosure is needed",
      "type": "boolean",
      "default": false
    },
    "exchangeRate": {
      "description": "Exchange rate",
      "type": "number"
    },
    "operationMode": {
      "description": "Operation mode performed on the exchange rate",
      "type": "string"
    },
    "exportToAccounting": {
      "description": "This would keep the invoice from being feed into the batch process (i.e. not generate an external voucher/payment) but would still move values in the system. This might be defined by the vendor relationship and exposed for override on the invoice.",
      "type": "boolean",
      "default": false
    },
    "folioInvoiceNo": {
      "description": "Invoice number in folio system",
      "type": "string"
    },
    "invoiceDate": {
      "description": "Invoice date",
      "type": "string",
      "format": "date-time"
    },
    "lockTotal": {
      "description": "Total amount which manually set by user. The calculated total must match this before the invoice can be approved",
      "type": "number"
    },
    "note": {
      "description": "Invoice note",
      "type": "string"
    },
    "paymentDue": {
      "description": "When this is required to be paid. Generally governed by the relationship with the Vendor",
      "type": "string",
      "format": "date-time"
    },
    "paymentDate": {
      "description": "When the invoice was actually paid",
      "type": "string",
      "format": "date-time"
    },
    "paymentTerms": {
      "description": "Invoice payment terms",
      "type": "string"
    },
    "paymentMethod": {
      "description": "Inherited from vendor record",
      "type": "string"
    },
    "status": {
      "description": "Open: Record has been created, Reviewed: details have been verified, Approved: Funds are release, Paid: confirmation that funds have been exchanged and check number has been returned amounts are frozen, cancelled.\nNote: invoices are never partially paid.",
      "type": "string",
      "enum": [
        "Open",
        "Reviewed",
        "Approved",
        "Paid",
        "Cancelled"
      ]
    },
    "source": {
      "description": "This does not denote a user ID but describes how the record was created. Eg. User, API, EDI",
      "type": "string",
      "enum": [
        "User",
        "API",
        "EDI"
      ]
    },
    "subTotal": {
      "description": "Invoice amount before adjustments are applied. This is sum of all subTotal amounts of the corresponding invoice lines. This amount is always calculated by system.",
      "type": "number",
      "readonly": true
    },
    "total": {
      "description": "The total amount is calculated \"on the fly\" of this invoice which is sum of subTotal and adjustmentsTotal. Must be the same with existed \"lockTotal\", when approve invoice.",
      "type": "number",
      "readonly": true
    },
    "vendorInvoiceNo": {
      "description": "This is the number from the vendor's invoice, which is different from the folioInvoiceNo",
      "type": "string"
    },
    "disbursementNumber": {
      "description": "The identifier for the physical transaction corresponding to a payment (Eg. Check #, EFT # etc.) Brought in from external source",
      "type": "string"
    },
    "voucherNumber": {
      "description": "Number generated by folio that will eventually identify the payment request sent out to external financial system.",
      "type": "string"
    },
    "paymentId": {
      "description": "Id of payment",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "disbursementDate": {
      "description": "Date payment was made from financial system (eg. corresponding check date)",
      "type": "string",
      "format": "date-time"
    },
    "poNumbers": {
      "description": "May or may not be provided; references the PO associated to the invoice",
      "id": "poNumbers",
      "type": "array",
      "items": {
        "description": "A human readable ID assigned to this purchase order",
        "type": "string",
        "pattern": "^[a-zA-Z0-9]{1,22}$"
      }
    },
    "vendorId": {
      "description": "UUID of vendor",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "fiscalYearId": {
      "description": "UUID of fiscal year",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "accountNo": {
      "description": "The unique number of the organization account",
      "type": "string"
    },
    "manualPayment": {
      "description": "This would keep the invoice from being feed into the batch process (Not generate a external voucher/payment) but would still move values in the system. Note: this is ideally defined by the vendor relationship and exposed for override on the invoice.",
      "type": "boolean"
    },
    "acqUnitIds": {
      "description": "acquisition unit ids associated with this invoice",
      "type": "array",
      "items": {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "The UUID format string",
        "type": "string",
        "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
      }
    },
    "nextInvoiceLineNumber": {
      "description": "Number that will be used next time an invoice line is created",
      "type": "integer",
      "readonly": true
    },
    "metadata": {
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    },
    "tags": {
      "type": "object",
      "description": "arbitrary tags associated with this invoice",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "tags.schema",
      "title": "tags",
      "properties": {
        "tagList": {
          "description": "List of tags",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false,
  "required": [
    "batchGroupId",
    "currency",
    "invoiceDate",
    "paymentMethod",
    "status",
    "source",
    "vendorInvoiceNo",
    "vendorId"
  ]
}

Example:

{
  "id": "733cafd3-895f-4e33-87b7-bf40dc3c8069",
  "accountingCode" : "0206",
  "adjustments": [
    {
      "id": "14263aab-b22b-4ddc-9ecc-3434427c2c8f",
      "description": "Shipping",
      "exportToAccounting" : false,
      "type": "Amount",
      "value": 4.50,
      "prorate": "By line",
      "relationToTotal": "In addition to"
    },
    {
      "description": "Some Tax",
      "exportToAccounting" : false,
      "fundDistributions": [
        {
          "code": "USHIST",
          "encumbrance": "1c8fc9f4-d2cc-4bd1-aa9a-cb02291cbe65",
          "fundId": "1d1574f1-9196-4a57-8d1f-3b2e4309eb81",
          "distributionType": "percentage",
          "value": 100
        }
      ],
      "type": "Amount",
      "value": 10,
      "prorate": "Not prorated",
      "relationToTotal": "In addition to"
    }
  ],
  "adjustmentsTotal": 14.50,
  "batchGroupId": "2a2cb998-1437-41d1-88ad-01930aaeadd5",
  "chkSubscriptionOverlap": false,
  "currency": "USD",
  "enclosureNeeded" : false,
  "exchangeRate" : 1.092,
  "operationMode": "MULTIPLY",
  "exportToAccounting": true,
  "folioInvoiceNo": "123invoicenumber45",
  "invoiceDate": "2018-07-20T00:00:00.000+0000",
  "lockTotal": 64.50,
  "note": "Some note",
  "paymentDue": "2018-08-29T00:00:00.000+0000",
  "paymentDate": "2018-08-29T00:10:00.000+0000",
  "paymentTerms": "Payment in Advance",
  "paymentMethod": "EFT",
  "status": "Reviewed",
  "source": "User",
  "vendorInvoiceNo": "YK75851",
  "disbursementNumber": "58",
  "voucherNumber": "478",
  "paymentId": "a5065f0d-fb88-4d23-b0c1-57e754fba40e",
  "disbursementDate": "2018-08-19T00:00:00.000+0000",
  "poNumbers": [
    "AB268758XYZ"
  ],
  "vendorId": "168f8a63-d612-406e-813f-c7527f241ac3",
  "fiscalYearId": "ac2164c7-ba3d-1bc2-a12c-e35ceccbfaf2",
  "accountNo": "GOBI-HIST-12",
  "manualPayment": true,
  "nextInvoiceLineNumber": 1,
  "tags": {
    "tagList": [
      "tag"
    ]
   },
  "acqUnitIds": [
    "1895e539-8dac-441e-b1f5-aab62b3fde60",
    "47f504bd-0c1b-498e-a2ae-e2f0a0cea273"
  ],
  "metadata": {
    "createdDate": "2018-07-19T00:00:00.000+0000",
    "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
  }
}

HTTP status code 404

Item with a given ID not found

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

"invoice not found"

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

Update invoice. Only in case an acquisition units list has to be changed, it is required that user should have extra permission invoices.acquisitions-units-assignments.manage to update an Invoice.

URI Parameters

  • id: required(string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)

    The UUID of an invoice

Query Parameters

  • poLinePaymentStatus: (string - pattern: No Change|Awaiting Payment|Partially Paid|Fully Paid|Cancelled)

    how to update the payment status of po lines when approving or cancelling the invoice; only applies to lines with releaseEncumbrance=true linked to po lines of one-time open orders; required when approving or cancelling an invoice in a past fiscal year containing lines with releaseEncumbrance=true linked to po lines of one-time open orders; invoice lines with releaseEncumbrance=false have their po line statuses changed from Awaiting Payment to Partially Paid

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "invoice",
  "javaName": "Invoice",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID of this invoice",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "accountingCode": {
      "description": "Number that represents the vendor is an external accounting system which may include details like \"Address code\" in it. This is the number as stated on the invoice",
      "type": "string"
    },
    "adjustments": {
      "description": "List of invoice level adjustments. The adjustments can be pro-rated which are defined at the invoice level, but are applied to the invoice lines. A generic example is a shipping fee which should be spread out across all of the invoice lines so that all funds involved pay some portion of the fee.",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "Adjustment",
        "properties": {
          "id": {
            "description": "UUID of this adjustment",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "adjustmentId": {
            "description": "UUID of the Invoice adjustment incase of prorated adjustments",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "description": {
            "description": "Displayed in invoice line as a name for the input",
            "type": "string"
          },
          "exportToAccounting": {
            "description": "Whether or not to show this adjustment in batchedVoucherLines",
            "type": "boolean",
            "default": false
          },
          "fundDistributions": {
            "description": "Fund distribution records from which this adjustment will be paid; only valid at invoice level",
            "id": "fundDistributions",
            "type": "array",
            "items": {
              "description": "fund distribution record",
              "type": "object",
              "$schema": "http://json-schema.org/draft-04/schema#",
              "properties": {
                "code": {
                  "description": "The code of the fund associated with this fund distribution",
                  "type": "string"
                },
                "encumbrance": {
                  "description": "UUID of encumbrance record associated with this fund distribution",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "fundId": {
                  "description": "UUID of the fund associated with this fund distribution",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "invoiceLineId": {
                  "description": "UUID of the invoice line associated with this fund distribution",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "distributionType": {
                  "description": "Percentage or amount type of the value property",
                  "type": "string",
                  "enum": [
                    "amount",
                    "percentage"
                  ],
                  "default": "percentage"
                },
                "expenseClassId": {
                  "description": "UUID of the expense class associated with this fund distribution",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "value": {
                  "description": "The percentage of the cost to be applied to this fund",
                  "type": "number"
                }
              },
              "additionalProperties": false,
              "required": [
                "fundId",
                "distributionType",
                "value"
              ]
            }
          },
          "prorate": {
            "description": "Displayed in invoice line per adjustment in toggled on in settings",
            "type": "string",
            "enum": [
              "By line",
              "By amount",
              "By quantity",
              "Not prorated"
            ],
            "default": "Not prorated"
          },
          "relationToTotal": {
            "description": "Relationship of this adjustment to the total;In addition to: added to subtotal;Included in: reported as subtotal portion;Separate from:calculated from subtotal",
            "type": "string",
            "enum": [
              "In addition to",
              "Included in",
              "Separate from"
            ],
            "default": "In addition to"
          },
          "type": {
            "description": "Adjustment type",
            "type": "string",
            "enum": [
              "Percentage",
              "Amount"
            ]
          },
          "value": {
            "description": "Adjustment value",
            "type": "number"
          },
          "totalAmount": {
            "description": "Total adjustment amount",
            "type": "number"
          }
        },
        "additionalProperties": false,
        "required": [
          "description",
          "exportToAccounting",
          "prorate",
          "relationToTotal",
          "type",
          "value"
        ]
      }
    },
    "adjustmentsTotal": {
      "description": "Total amount which is sum of all invoice line adjustments and all non-prorated invoice level adjustments. This amount is always calculated by system.",
      "type": "number"
    },
    "approvedBy": {
      "description": "UUID of user that approved this invoice",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "approvalDate": {
      "description": "Date the invoice was approved for processing",
      "type": "string",
      "format": "date-time"
    },
    "batchGroupId": {
      "description": "UUID of the batch group to use when generating batch vouchers",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
      "default": "2a2cb998-1437-41d1-88ad-01930aaeadd5"
    },
    "billTo": {
      "description": "UUID of the billing address",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "chkSubscriptionOverlap": {
      "description": "IF TRUE the system will check if there is another invoice for this subscription and whether the dates overlap. IF the dates overlap, the system should issue an alert.",
      "type": "boolean"
    },
    "cancellationNote": {
      "description": "The reason of the invoice cancellation.",
      "type": "string"
    },
    "currency": {
      "description": "Ideally this is the ISO code and not something the user defines",
      "type": "string"
    },
    "enclosureNeeded": {
      "description": "Indicates that an enclosure is needed",
      "type": "boolean",
      "default": false
    },
    "exchangeRate": {
      "description": "Exchange rate",
      "type": "number"
    },
    "operationMode": {
      "description": "Operation mode performed on the exchange rate",
      "type": "string"
    },
    "exportToAccounting": {
      "description": "This would keep the invoice from being feed into the batch process (i.e. not generate an external voucher/payment) but would still move values in the system. This might be defined by the vendor relationship and exposed for override on the invoice.",
      "type": "boolean",
      "default": false
    },
    "folioInvoiceNo": {
      "description": "Invoice number in folio system",
      "type": "string"
    },
    "invoiceDate": {
      "description": "Invoice date",
      "type": "string",
      "format": "date-time"
    },
    "lockTotal": {
      "description": "Total amount which manually set by user. The calculated total must match this before the invoice can be approved",
      "type": "number"
    },
    "note": {
      "description": "Invoice note",
      "type": "string"
    },
    "paymentDue": {
      "description": "When this is required to be paid. Generally governed by the relationship with the Vendor",
      "type": "string",
      "format": "date-time"
    },
    "paymentDate": {
      "description": "When the invoice was actually paid",
      "type": "string",
      "format": "date-time"
    },
    "paymentTerms": {
      "description": "Invoice payment terms",
      "type": "string"
    },
    "paymentMethod": {
      "description": "Inherited from vendor record",
      "type": "string"
    },
    "status": {
      "description": "Open: Record has been created, Reviewed: details have been verified, Approved: Funds are release, Paid: confirmation that funds have been exchanged and check number has been returned amounts are frozen, cancelled.\nNote: invoices are never partially paid.",
      "type": "string",
      "enum": [
        "Open",
        "Reviewed",
        "Approved",
        "Paid",
        "Cancelled"
      ]
    },
    "source": {
      "description": "This does not denote a user ID but describes how the record was created. Eg. User, API, EDI",
      "type": "string",
      "enum": [
        "User",
        "API",
        "EDI"
      ]
    },
    "subTotal": {
      "description": "Invoice amount before adjustments are applied. This is sum of all subTotal amounts of the corresponding invoice lines. This amount is always calculated by system.",
      "type": "number",
      "readonly": true
    },
    "total": {
      "description": "The total amount is calculated \"on the fly\" of this invoice which is sum of subTotal and adjustmentsTotal. Must be the same with existed \"lockTotal\", when approve invoice.",
      "type": "number",
      "readonly": true
    },
    "vendorInvoiceNo": {
      "description": "This is the number from the vendor's invoice, which is different from the folioInvoiceNo",
      "type": "string"
    },
    "disbursementNumber": {
      "description": "The identifier for the physical transaction corresponding to a payment (Eg. Check #, EFT # etc.) Brought in from external source",
      "type": "string"
    },
    "voucherNumber": {
      "description": "Number generated by folio that will eventually identify the payment request sent out to external financial system.",
      "type": "string"
    },
    "paymentId": {
      "description": "Id of payment",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "disbursementDate": {
      "description": "Date payment was made from financial system (eg. corresponding check date)",
      "type": "string",
      "format": "date-time"
    },
    "poNumbers": {
      "description": "May or may not be provided; references the PO associated to the invoice",
      "id": "poNumbers",
      "type": "array",
      "items": {
        "description": "A human readable ID assigned to this purchase order",
        "type": "string",
        "pattern": "^[a-zA-Z0-9]{1,22}$"
      }
    },
    "vendorId": {
      "description": "UUID of vendor",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "fiscalYearId": {
      "description": "UUID of fiscal year",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "accountNo": {
      "description": "The unique number of the organization account",
      "type": "string"
    },
    "manualPayment": {
      "description": "This would keep the invoice from being feed into the batch process (Not generate a external voucher/payment) but would still move values in the system. Note: this is ideally defined by the vendor relationship and exposed for override on the invoice.",
      "type": "boolean"
    },
    "acqUnitIds": {
      "description": "acquisition unit ids associated with this invoice",
      "type": "array",
      "items": {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "The UUID format string",
        "type": "string",
        "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
      }
    },
    "nextInvoiceLineNumber": {
      "description": "Number that will be used next time an invoice line is created",
      "type": "integer",
      "readonly": true
    },
    "metadata": {
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    },
    "tags": {
      "type": "object",
      "description": "arbitrary tags associated with this invoice",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "tags.schema",
      "title": "tags",
      "properties": {
        "tagList": {
          "description": "List of tags",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false,
  "required": [
    "batchGroupId",
    "currency",
    "invoiceDate",
    "paymentMethod",
    "status",
    "source",
    "vendorInvoiceNo",
    "vendorId"
  ]
}

Example:

{
  "id": "733cafd3-895f-4e33-87b7-bf40dc3c8069",
  "accountingCode" : "0206",
  "adjustments": [
    {
      "id": "14263aab-b22b-4ddc-9ecc-3434427c2c8f",
      "description": "Shipping",
      "exportToAccounting" : false,
      "type": "Amount",
      "value": 4.50,
      "prorate": "By line",
      "relationToTotal": "In addition to"
    },
    {
      "description": "Some Tax",
      "exportToAccounting" : false,
      "fundDistributions": [
        {
          "code": "USHIST",
          "encumbrance": "1c8fc9f4-d2cc-4bd1-aa9a-cb02291cbe65",
          "fundId": "1d1574f1-9196-4a57-8d1f-3b2e4309eb81",
          "distributionType": "percentage",
          "value": 100
        }
      ],
      "type": "Amount",
      "value": 10,
      "prorate": "Not prorated",
      "relationToTotal": "In addition to"
    }
  ],
  "adjustmentsTotal": 14.50,
  "batchGroupId": "2a2cb998-1437-41d1-88ad-01930aaeadd5",
  "chkSubscriptionOverlap": false,
  "currency": "USD",
  "enclosureNeeded" : false,
  "exchangeRate" : 1.092,
  "operationMode": "MULTIPLY",
  "exportToAccounting": true,
  "folioInvoiceNo": "123invoicenumber45",
  "invoiceDate": "2018-07-20T00:00:00.000+0000",
  "lockTotal": 64.50,
  "note": "Some note",
  "paymentDue": "2018-08-29T00:00:00.000+0000",
  "paymentDate": "2018-08-29T00:10:00.000+0000",
  "paymentTerms": "Payment in Advance",
  "paymentMethod": "EFT",
  "status": "Reviewed",
  "source": "User",
  "vendorInvoiceNo": "YK75851",
  "disbursementNumber": "58",
  "voucherNumber": "478",
  "paymentId": "a5065f0d-fb88-4d23-b0c1-57e754fba40e",
  "disbursementDate": "2018-08-19T00:00:00.000+0000",
  "poNumbers": [
    "AB268758XYZ"
  ],
  "vendorId": "168f8a63-d612-406e-813f-c7527f241ac3",
  "fiscalYearId": "ac2164c7-ba3d-1bc2-a12c-e35ceccbfaf2",
  "accountNo": "GOBI-HIST-12",
  "manualPayment": true,
  "nextInvoiceLineNumber": 1,
  "tags": {
    "tagList": [
      "tag"
    ]
   },
  "acqUnitIds": [
    "1895e539-8dac-441e-b1f5-aab62b3fde60",
    "47f504bd-0c1b-498e-a2ae-e2f0a0cea273"
  ],
  "metadata": {
    "createdDate": "2018-07-19T00:00:00.000+0000",
    "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
  }
}

HTTP status code 204

Item successfully updated

HTTP status code 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

"unable to update invoice -- malformed JSON at 13:4"

HTTP status code 404

Item with a given ID not found

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

"invoice not found"

HTTP status code 409

Optimistic locking version conflict

Body

Media type: text/plain

Type: any

Example:

version conflict

HTTP status code 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "errors.schema",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "error.schema",
        "description": "An error",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message text"
          },
          "type": {
            "type": "string",
            "description": "Error message type"
          },
          "code": {
            "type": "string",
            "description": "Error message code"
          },
          "parameters": {
            "description": "Error message parameters",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "parameters.schema",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "total_records": {
      "description": "Total number of errors",
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

Delete an invoice with given {id}

URI Parameters

  • id: required(string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)

    The UUID of an invoice

HTTP status code 204

Item deleted successfully

HTTP status code 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

"unable to delete invoice -- constraint violation"

HTTP status code 404

Item with a given ID not found

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

"invoice not found"

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

get post

Manage documents associated with invoice

get

Get list of documents

post

Post document attachment/link;

Get list of documents

URI Parameters

  • id: required(string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)

    The UUID of an invoice

Query Parameters

  • totalRecords: (string - default: auto - pattern: exact|estimated|none|auto)

    How to calculate the totalRecords property. "exact" for the correct number, "estimated" for an estimation, "auto" to automatically select "exact" or "estimated", "none" for suppressing the totalRecords property. For details see https://github.com/folio-org/raml-module-builder#estimated-totalrecords

    Example:

    none
  • offset: (integer - default: 0 - minimum: 0 - maximum: 2147483647)

    Skip over a number of elements by specifying an offset value for the query

    Example:

    0
  • limit: (integer - default: 10 - minimum: 0 - maximum: 2147483647)

    Limit the number of elements returned in the response

    Example:

    10
  • query: (string)

    A query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.

    with valid searchable fields: for example metadata.createdDate

    Example:

    (username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode

metadata.createdDate > '2018-07-19T00:00:00.000+0000'

HTTP status code 200

Returns a list of document items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of documents",
  "type": "object",
  "properties": {
    "documents": {
      "description": "an array of document records",
      "id": "documents",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "Document metadata",
        "properties": {
          "id": {
            "description": "UUID of the attached document",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "name": {
            "description": "The original document name for display purposes (filename or link 'nickname')",
            "type": "string"
          },
          "invoiceId": {
            "description": "UUID of the invoice the document is attached to",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "url": {
            "description": "URL pointing to the document",
            "type": "string",
            "pattern": "\\b((?:[a-z][\\w-]+:(?:/{1,3}|[a-z0-9%])|www\\d{0,3}[.]|[a-z0-9.\\-]+[.][a-z]{2,4}/)(?:[^\\s()<>]+|\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\))+(?:\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\)|[^\\s`!()\\[\\]{};:'\".,<>?]))"
          },
          "metadata": {
            "type": "object",
            "readonly": true,
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "metadata.schema",
            "title": "Metadata Schema",
            "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
            "properties": {
              "createdDate": {
                "description": "Date and time when the record was created",
                "type": "string",
                "format": "date-time"
              },
              "createdByUserId": {
                "description": "ID of the user who created the record (when available)",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
              },
              "createdByUsername": {
                "description": "Username of the user who created the record (when available)",
                "type": "string"
              },
              "updatedDate": {
                "description": "Date and time when the record was last updated",
                "type": "string",
                "format": "date-time"
              },
              "updatedByUserId": {
                "description": "ID of the user who last updated the record (when available)",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
              },
              "updatedByUsername": {
                "description": "Username of the user who last updated the record (when available)",
                "type": "string"
              }
            },
            "additionalProperties": false,
            "required": [
              "createdDate"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "name",
          "invoiceId"
        ]
      }
    },
    "totalRecords": {
      "description": "total number of records in the array",
      "type": "integer"
    }
  },
  "required": [
    "documents",
    "totalRecords"
  ]
}

Example:

{
  "documents": [
    {
      "id": "10a34f8a-98d1-45af-a9f6-14b7174ceb51",
      "name": "sample.pdf",
      "invoiceId": "733cafd3-895f-4e33-87b7-bf40dc3c8069",
      "metadata": {
        "createdDate": "2018-07-19T00:00:00.000+0000",
        "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
      }
    },
    {
      "id": "36c07579-6699-496a-b9d8-b45c0fd90e35",
      "name": "dummy.pdf",
      "invoiceId": "733cafd3-895f-4e33-87b7-bf40dc3c8069",
      "url": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
      "metadata": {
        "createdDate": "2018-07-19T00:00:00.000+0000",
        "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
      }
    }
  ]
}

HTTP status code 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

unable to list documents -- malformed parameter 'query', syntax error at column 6

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

Post document attachment/link;

URI Parameters

  • id: required(string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)

    The UUID of an invoice

Body

Media type: application/octet-stream

Type: any

Example:

{
  "documentMetadata": {
    "id": "10a34f8a-98d1-45af-a9f6-14b7174ceb51",
    "name": "sample.pdf",
    "invoiceId": "733cafd3-895f-4e33-87b7-bf40dc3c8069",
    "metadata": {
      "createdDate": "2018-07-19T00:00:00.000+0000",
      "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
    }
  },
  "contents": {
    "data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQAAAAEACAMAAABrrFhUAAADAFBMVEVHcEz3+PgAAAD9/f0AAADz9PX19vf+/v79/f4AAAAAAAD6+vvx8vT5+fr7/Pzr7e/7+/v4+fnZ3eHb3uLz9fbk5+r8/P34+fru8PHa3uHi5ejp6+3q7O/09fbt7/D6+/vs7vDd4OTt7/H5+vrj5ur7+/zo6+3l6Ove4eXp7O4BAQHm6esAAAAAAAABAQEAAADv8fIBAQEAAAD29/drbW8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADs7fAAAAD////+/v4A/fj9/f329/j19vfb3+P7+/v4+Pn5+vr7/Pza3uLs7vD09fb8/f36+/v4+fr7+/z8/P39/f7t7/Hr7fDv8PLk5+ry8/Xx8vT8/Pzj5un5+fr+/v/9/v75+fnw6eX+///v8fPw8vPn6eze4uX3+Pnl6Ovp6+3z9Pbq7O7h5Ofm6ezp6+7f4ubz9fXo6u3i5ejg4+bc3+Pf4+fv8/v55O/x8/T5+vvh5Ojr7e/w8fPz9PXc4OPy8/Tg4+fz9fbv8fLw8vT09vfq7O/c4OTn6uzh5elrbW/n6u3m4OBHR0jm6evd4OTX3ODd4eXM09nZ3eLi5unp7O7V2uDI0NbY3OG+yNDS2N3BytLT2d7O1NrHztRJSkrK0ddMTEyuuMPQ1tzZ3eG6w8x9fX1FRkfQ1dvb3+TEzNO1v8motL+dqregrLm9xc60vcfe4ub3+Pixu8WksLyrtsCbqLVERUbS19vk6OvV2t64wcqBkaHt8PLb3+Lj5uqnsr2Rn62UorCirrra3uMqKiswMTKFlaX09ffY3ODx8/WXpLFpfI/j5+p8jZ0VFRV3iZpvgZQJCQmwsbI6PD8eHyBzhZcEBASMm6o0Nzmap7OYmJiLmqglJynx8/OPnqxDSU++wcM/QUTO09d4eXpydHWHl6a4uLlRVFdZXF9hdIeam5y1tbXFyMqrra+fn5+EhYajpahgZGf2+PkRERGQkpPo6+0A/wATchRCAAABAHRSTlMA/gP+av7+/v7+lf7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v4I/t3tWNf+U/j+/nYQK3IBjx4XRwLnOqK9XsWbt6X+//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////8Dp+MUHAAAHOFJREFUeNrsmntMVOkZxhdnXUTWKc6oKDFxibhQRLxQ79e9tI0zAcfCUUTYlhQCpOpCm3EnO8AfgNhRdwc1Xa4ryMWyAg2OyCVcioqIqLDKKq6KKGCo2npZtZpt1/T9vvc7ZwbLoMCZA3/4JORNjAl8v3nf533Od+att97ojd7ojd5o8Fo6RhotHYVnX7Vo+eKVHy0bL4WWrfQcbZ/8ojXe4z+e47AWZfM613tUEVi6/KPxcxc4SCkv71F0/uVLfrUaPxzJOmDtWq/5o+X4nvM/nCPhwfnqMHd0EFi1+AM4/ggAIATGjIKP39tL6oObq9fIO+GKJQvWjhyAtXO9R7gHli9b0OcP+m/Lw31/G4z+aaF/8dq3b98v4OdHqkegh6B/EN29e/36rVuP2gUQI7wLYPwtPpGrd59fe7pzt1oFsleh/q+qiSJDpgQGhwVsTkiYEBQU7ef3xbeTki/u2XLqkw3TP9t+/PTe+PRzOQdyizKyTXkHS45WHy6rKa9rPtPT2nD5xvff/fBDRXe70AkjugtW/NJi9V99dG3aWPtXa5yMaopcPstphuMEZ2c7Ox+fdyZNGnvx3Xmn3vvZ9P2zJ7vtrTISAqWEQAUj0NXcyxPI+zMQ4DWCu2AR9D//SVz9y52NYQN98kKNoD0gC/GlPeCYkAA98B+/d77d9SfSA+9t+C3rgSP99MDN1oYrAMCkXve4ne88hxHzgTELzbN/+ye/Vx1cqJSALBIJzNiMBHy+YAQ+eQUB0gImtWri4w5h9EZqF6xcwAO4+vc7r3FwoRICMjUScAIAhICPHxKYBwSSgIAbI1Dah0DbmR7SAofUKvuo7g7BfEemBxZ/LJjfo3u+gwFACMiIEwYGBssDkIAdccJdyRff3YIE3K30QO/9yzcoAFXUs3aLPDACA4ALEP6Aqz8W+6oGBQAIyNRIQB6GBOyiGYE9SGC2tSkgLUABqKK62815QHonXOnFHn46H8b6qgYJQBUxDrdhoBy3YYIzbsNdYxmB/S/5gLALegFANgWgSu4W8oD0u2DRBw7MhK4Xqy0PGBm8aePupKTpSShr9edffk302fsvXrzYn5Ky3T3meOilLH2iIT62yqjhMtMO5OcWlWYUZh8iH//JyurDtU1nj3W1nbl/+fvvGACV3+MOcx6Q1gdWzfdia7j9juWSl/tMnRynBCmUKOtVQXUBlJaWdgKUn59bX19aWlBw715hNhzclJd3sKLk5FFy+LKmmnJy/N6ehhuwBvlfN7G7w+J+wFPSCMTIdz63aG3fdV/rNCjlK+s5jkiRWQzKoQRO5Ofm1hcRBPDJEwSEQAX5+KvNBFqv0DXIOo7tAuoFUu6CpWu8GIBb+j9Q2cNPwAbtaxxcqJSAgmMEDiCBep5AYWFfArWMABkBMwDIA+3mPCCdD3gu7GQB8FlUBJV9RERQSqpmMAAoAQXHEQDFZBAIglw6BqUF95CAiRGopASICfTAGrQAYO/X3W7OA5IRWPEhM5+79b402arHqYNijHFxcZo41GtVQKAkbQBNoIAmoAgEJ8ggBIgFCkZACfQ2sBzAj15yt5AHpNsFix0QQOdPE/H8all0jJEozmgcRD2CHXEORyEHB4F3AkIg22Qy9SXQLOQAVYCaek/Usw4+D0jmhEvYL2x5KmMAZn6eSrUzdVD1CN8J00gf5MAg8FZACACCQzgGJSdxEzadbWvlc4BaH40giBOa7wckIfBr/IWdj/7IAPhOTR0SgNSdKI2ysbER3ICtRDOBbBwDYR3WdIELMgBcuJ+ajkLU43aL9wVSvDNiIeDqcxmTncF1yEJXPAfhYJpCkXOBESBjQHuALQN+CurABbMxBSiUbj4sDzw23w9IsQs82T1Ax7/VrAOSXNNRQ6joCUghU0GcIM3shfcyCvkeKKEEym823ChkHcBx4Xb0/km1rrvdnAdsT2BxJwJoecoArNcOA0A6HQVgQCAoYQ5yLvDrgI0BT4D4wFl4GDAD4LQJFIB6bHe7dO8LVq1hAK43RsoiiaZ+6vEpaiiVEHBNNRqJGSgbOWoFSCC3SLBCPhLVnGm9kmEGoIgNwjtI/2fm+wGbO+Hb7EXIX/1CZCGgwM91HjrUkGoV64jUVCNdCZmZOcI6IIkgw7wMKsuaWy9bAuDILiDrEFOxA7st95QEwDchIVMIgKDQ4QEAAjgSdCuQWJCZk9OXQDZPoLbtfl8AZBdgHnhscT/gLQ0AX98pvqCNWbEesagh1iocCeIFQEDTyCmKhXXAE0AjONzW09AXACWAecDifcF8iQDICYDk8OECiGWeAF4ATRCnaVTyTgAI2PMhEqjuutlQ0BcAlxWNeWDjs/PmPDDfpgBQ38hRO1x0w5cHiiQDIHCO3BfwY1BksQ6r6wAAywG8lIYJLA88OW/xvmCVZB2wW6/VaVFDr/HYCVW0EeggwD64QJ4OmBFgJqo81tta9FIHcJzBGfOA6kFLp/D9Ads5oQAgMFAeCAIAsewgw6gGHAkk4GrkCdBUVM+Pgelk+Zl+AHAufkjA/kmLcD9gu11gGwCUAHiCjhCAXEAJKIqZFxaxTHTybPP9fgAow/3YO8kH5y3ygEQAtui1BnaQYVWDIVYHEHSAwAMygZE8IWQCgQPkoqQIe6Ckpl8ACtyG5N+fnDe/L5hvYwDBwfJg0JbwRG0iapjVEGsAxYMlQkBMTzUeIWNAm4AF48KKmraefgFwWUERFIA/IeBg011gAWAWAtBr9ahh1kTsCAOMAsnI6UZNnIZfiEigoqntZm6/AOC5IILmgfXgA8L7ApvclAoAwsJmhYF+F65PZAcZdmUTAaNACbjCc6LghYTAwbIuawA47W8wD8AusHhf4GnDHOCEmufmIp4S0Q3AEXUsGMAz4jQFWYhghQV5ZXW9uS/lACEPuLD7AdgF5jzwtqctO8CJdMDu0HCXcNTw614ciUS2FYgVQDKcRp0AUqGpFgBY6QBIxT58Hrgt3A/MWehpMwABAU4BIFEBIAGtHvciBCNKQIlemF9vOnzsTL5VAJwbnweunRfywJwlnrYDMEN8AJSAltoBWYuUAGxE9ML8QwMDUOqDEADdBez7hKvFJvAygC0xoW6hKFHqaQoiay9uBUNsFTwuQy4CM8w5kF1d3jwAAAUXm4B5IOxBi/C+QOwpEABs3uy4GSQ2ACBAOoEQwKVYVeWRjgTSCqvPNh8YCACnjcb7ARUhwLbBnIWLbAlgh9gAQk/TkQACxAwJAY90JJBWWFnTxh6HU/sHwGWx+wGVOQ+I7IT9AJjMDiBaRUvIctGjG+rACsAJGhUZlTVdeezFiBUAwvsCeC4Q8oCoBIQc4Ija4T5ZfLlRZWEygHQMY+DhqlEWnCyrq8Rl/77CipRudvg/plwz3w+I6YRCB2za5LgJtGN7zOQYlHj1OI7EadwKBm18PHihUVNUUnusPJJ+3e731jqA4/TO+E2cKLYNyfcJVy8ZYwMAM20GICYGPQEJwMMS6YJ01/yKw+XNp+iM+6daBcDp6C6IUMsfCPcDDuI54csAtm6LcWd/uKgVPQEIhOupF4AVeOSYqmvacimAsBTrABT0tjxCLYvEGxIHUXeBACAhYWYCaGvKV+5foUSt2AmhocQNw0k60sZXaQqPNtVVBxIA6uRU6wDo/QAB4PtEyAOi7QILABMIgB0p2923o8StOArHj1+65AaDsFefmBifXlpSW16+gbr8+m0DACAEKABf8/2AWKlYMgBQY3AWiBmCF4ARnDhYfbbORAGok3UDAODCo0MoAH9wQn4dirMLXgawNWXb7G0o0StvijgIepdETfbRsrqy6dTlQ5KUAwDg9EEUQKDftdtCHhBlFwg5wBm1NWW27eROxZIBxIKqItgDXSY5XfSy2UrFANLZyWQyudzJ8YH5fkAMJxQ6wN/f2R+058X+bftRNqjCKEAyAC/QZx462nSsbG8k7QGnmP+xd34xbd1XHBfrzEudsXShcSDJAkkNVl6QkPK290jVgJVgNySywTegIdmAscHMREjXYM/8iTFCyUbIBUooiaBRSojJHwgZyaz8wU0RS6JO6aqmalepk/qQh0hTNbRzfudnoFKWrsrv2tdJz8t59L0fn98539+f87vPiYCKiqO6dyECDh30P7q3YX1gn0AAmxGAs8lX7yNTwQ/gUCjAjIi5oKamC0JgaeHmCk17/SfKngOg4mjoCAOwdeP6wAvXgmcAiPAHVsMPsJxABLIhFVRMzFycXRjx0z7A76ytzwHwKyDAADQ+Wt8veOFasAagtnZzLZizaTWySqaKH4hE9kYikRZQBtmu6pq2sffmbkejQ/yI7m9LXWXPKYetoQMMQOjp+n7Bi9aCZwAw8gdWx0MQRJBAywnMBdXNZy9Nzi9E2/m8/+3DpSf++L+rwZ/+wACU9Dxd3y94QQJrACorN1eCSV6v0UumkvcN4HiAnFiAA8EVHzk3OR+Njh5cOzH6ZshTzdaSu8i4ZxuubZUMgCX4aOP6wD4xADIQQK+iNgCv0UcE9rJUUDN8AQgsLE0t/2Bnyu+pCjAAzqf3NqwP7BOgAzLI9KZc1c3ILAKSC6VBzviFmxADs5eMrz23SfE1rgN2b83I3KFzGp5+tEEP/ExYBEgeT66HTD3vbUIz+oABJMOcGxPnJm/PRifH6n5EBMTM/96wX/CbFwdQV5dRByaFPSb+oCp6LyIwQkKM1NefKOgfHrl0+RoEwdyQ/0cAyOYEcH3g5wIBhE1hMlU9zwmUDKunT56+OXdxKRqdnHIfevPt/w+AsZkICALQ2JjRCCZ1dpoSzVBq+rCi5GKnFfVZtTSPj7wHCLCTZG5k0BZzgBlizKz5VjOYLbw9DLxaXIt7+jvaG/oq/jz24cn//EMkgOJkAugMs5ygeEF4QSpw1ZSNIQJsp4tGo/MXL96+PT8/vzQ7OxtdWPjii7/dvXvn668///LLbz/++K9oDx9+8tlnf7//VfoC6AyznAAxQMnQ1RyfmjiNLYXXsK1qfglePoovj+9+B96dvTq8N7442P379588eaJCBNh+sE9QmA8TAUiGvkg9KMO2vuGTE3SUembm8tzc3OTk5DWIBQiEKIIgDEThE/j774sBwHVAMZl+V1bybLuJjOkCUAUFe7ry3hhfO0d3gbqMzs1cpn7DJew1uwsUcBQ8ZAi+4o8vLgJksznLTKa+t/HOU0wFMA2HZOiqfnAKjxddaegr2/bB6PD4GB4mGrlwAUDMrPecYiggApE5oKSkuAQsqQCIgKmTCEAuQHFcvae/raO5/crgNLbd4mGa98+epa7bGUZgdgFGw53PGQGhADIRgJRUAIyAiRVFL1OGbPUYG4+b21sL+4jA1DMIAAIWA+IByFbzLv6AyfG2ziyqioqpCbMhTpOr2aJxa8NgWXwIhsFfaBhAeiQC87NQHOgako9UAGDdZSVLjucRgZHgIV20F4bBrZr+jq523ECsGL1xY2xqncBlRgDSISPwEgCwmvfzSGDJEAjgNJkRaCYCeLgU2+8nNhBYWmIEvn0ZAFj5kLBtZ8nQu8oyAZ4sgWGABLaNcgLrMQA6kQjcE6cDMsn0+Tt37SRLmueWlYWaAJcLIiAJsrP35OR0tF4pzCsbolHwLyJwDglcu0YE7onTAYkIMBjyDWTJ84lIwGwI0+WmVYwCqAY1p9qaj17J6ysbGsZigD1n1G41xxXB3XvihkBpaWYpmByL5dMsLKmehgTVRRNOEgdaWgoWH9yCatA+ONgXJwJYDk+fph58IiAUwA4EIKUGQIxyAk+GRGCvixPARIAExogA673Fe1iAwMsDIEZJkSdDRqAe5v7Vt061UTlEScTK4QTeQ8M0ERB4LByAXFVlqCJLro9ZdyZ0AdNFTBmewCMVOW1YDKa/R+AS10QqAOjpMfSQJdnHWFKksojJUMmFXNiCe4iQCmFy1LdtdHhNErFqAATEA1hxOAwOsqR7PiQoGYbDJhAFuAQGc4N+TATxeIIAzpRJFz8WpwN2kK0UGVJn+WQkCrazhYIBpghOgS4uzJvexu5kQgITEzQ3eixMB5xZXt6yDGYPOIr4P5ICz5MiT4bhsOL1+eoLXIsojNsLB/FqRi4IRiaYKvxU2BA4Y7FssYCFAoGiAFkKvIMlRVYUIRnamDbGROCqfoCjoKEv/gHOj6nrDgkIBaBjAJzOIidZKryDkmJsLRl6FMUIU2S2UoQEyvgKwft0Md1LB8DpcLCqgEGQT8JQMaEsBFGUgwQGy+hyNogCjAEVAPT2BnrJUuR5ToBcAOPAZgNlqNCGSPatftRE02+MDo9jLsRyKBBAd7euG0yWpIBEliLfy3ICEGDJEAhsD+MWGswNqokAzA5xieBDJKAKACd/oJT5ABFYS4YwDBQ2NwACMAzypitGUREggU+F6YAzOp1dB6Z3asCKyFAZ7NyJGxUmUy4tEuzJ6WotzItvw2GA5fAbcTogGLQHwWRZ1stkqfMSYXBQOeDVoGkAqsFiNZXDsjjtGXwjbggEgyEEEAqF9CGyFHoJEQRgLPSALMBkiAhMPjZB7O9oPgqpkAiIB2C32/V2slT6FZYUoSQ4HFWkDKEa4GkCvj0OqbACy+FLCwAJQFVgBFgyZNJY8SKB7FtEAGaH40IB6LUEAAhgVUACRVVEAKsBEihYJAJxkETiAQQ14+2UFHspGcZo0dTjxX0DIjANolAggLV/gIZCMJh6z0yWIBn29FTF2P4BIwCzIyRQ2Bcfui5OB+i52TVk/JFgogiiABcK9u8HSWAcqAdB0MEEwXVxOiBRhuxuu5vZltR7jmEFJwoORz6MA4iBMFYDEIUdXUcb+q6LGwIJIRJ06+gBNOEJABHAJTMkkBX2rrYsPsB5QYNQAE58/1CQ5gTd3ZrwbpYUV1YoGbLVc6gGYS+EAJseqwGApsUWiza8m5KinZKho4qqgWcVVDEKIoEA+HRUawCAAAm0kIzqGIIAt9A6m1pIEL0CACxuO8kCWQ8ThEAVLZQofH3gvHAAdjctjlos2vHuhDDCtQKUxlZz2AeKEErBeXE6gC/NrmzRouFKhc6+ApoAZskGQyw/C8VAQXb2eXE6gC9KrliO7ThGph2/TFUBIgHLAS6XdSooiV2LAocAByBbaIustFRLfpnlBCyKmAx7AzGzoqziavlxcQD4BoU2ATACOgsR0Eu9DjPfLxAPQNImACQAVYERgGQYsIY9Cp4sfWUiAAlgVUACMEN0WsNhT67PVy8QAN+kDPGzQqXa8ztYUex260ATGLD1BiZFQgEYCACdFisp0Z5nGI4tb+l222M2Gzs/cFycDuBb9KFMDRsdYUBZUMTODxiNx8XpAH5URcsRUMKHwrIl2GNmZ4ubBA4BflhJ0wCIAAgjNwHwKAIB8ONq2gZQQlXhmMVBh6s94gHIvHOkRKueqoKTH64WD2Cl5GrxVTJtehoKvWa2TxBWAwA1TzU2atV/xwDQGaJOgQD46W3tA2gsTgAwiwHAdQA/vK8vTgPLzHSyo4RZJoE6gHdwSGkQAY3flQTMwofAOoAM/kMa9tjdxxovxQMIXaV7BOrqtOyvyrzx8pUFEOKNlyoAaKS7RCortewbQ9ZXHgD1GwoEwFtZ5fQAgDlgv02oDuAt/fqMzWlgGXp+/4BAHcB7eOV36E6x2lot+3dk8WUwHQEILYMJAHV0r2B5uZZ9nSy+DL7qAI7bbFk2sHQBYKPnFQiAX28jVdLlquXlWvaVEr+ORygAEwHwb/WTadgzAKZOoTqAX+mj37opDWyrnj+uOB2wFgG1dMO0369lXysyAr4PQE4PALKaAHbzH9KwVwMAv+hQLqcPLRw8qGVfLvOLGQUC4FdepgkAiV/RKRQAu/T0n+kBwMkvaRUPACLgdf5DGvYsAkQBIDvO7/zVb3o9DWyTnj+uQB2gKEYFTPbTF6cOHdKy90sKPa/AIcCvvpbSBAC/llcVAL/mP6RhrwaApiYj3nct+em7gwcOaNn7pSZ6XoEA+P3/aQLAyb9XIBQA+wJEb/oAiPwEQAwArgMiEfbpC/3uX6aB7dZH6HkF6gD+ORzJT98fPnJEy97v5J/vETgE1gG8xX9Iw94viQfAh4Dkp4+wHz6sZe+XEkNAJAD8/k/EmR4AnBF63p8AiAdw8N1f/Le98wlpI4vj+CNZcGPBlpUWt5cSsDUN0dZBE5OYNP5rdxqCFrQq/tm6GFtoo/QQGBjtRaIED4vCEoQ9r1uQeu5JL3pT8FQYLUMOPWRdqSVEKvSwM/n9xk2P67zZfY+dD+jvNvm+j7/35qcH3xDAcB22QMD0dIN+ExovAqYhL8U5AO4CbEjdqOGAGymMS3EOwKsxU4946IBHKbzKk+IWOBeQqEkADFcrBOD1uLwIwOt8bQH0BOBV2Rk+BGTwSm9bgC2A2hxwFcjcvMYBNzMYl+IcYHTAyNi1MYDhOkJ/C2xMTFyd0OBFwATk3aApoL4soH/MiR/EcO3XBdRbIuBF/zPnM4Dh2v/COgGTPAiYtE5AZjLujAMM18mMLYCeAGCjHrhb4+SAmrsYl97/EdpIJq8nNZb46IClJOSluAVsAbYAW8D/W8Dy8vVlDV4ELENeigJkeV7WeMKHgCcy5KU4B6SBOj7mgDqMS3EOkOU0Zx2QptQBtgBbQFnA/Hx2XmN79Om3TwGG6+j2POS1REAVfhDD9VwAvf8rrL0Fsvqxuj30vOo5wHAd2k5DXqoCZjkTMEtJAM4Bs0Cds4oDnHUYl979ApvptFTugMTDqocAwzWhd4BEdQtsZrNSVoMXAVnIawuwBVATMDsrlQ9BPgToh6Cel6oAD2cCPJYIeDzKg4DRxxQFAJse4NYVHuaAK7cwLsU5QJI8ksb0MA8dMDwtQV6KWwAFyFM8CJiSqQv4Yx8ESINx9gXEByUQsG/+srWYCgLypRnPjM44DwLG9aRa3hJevq7GLrr+aAAFfDiYcZcFpEfYFzCS1pNqeQ92UUDgwh3gFUDA++Kqe7XMEvsClspBtbzF9yBA8F5YAPGBAOVPQ0DyEusChpMoYOBYAQG+i6+fPMA36cnvbsBzmfU/Bvzgwai/nWD4ByYEtEEHiHsH2AGr2QW2O+Cn9Cp2wMGeCB3wjQkBARcIUD9/hwI8yV6WBfT+ijnd659VEOAKmBDQ3gkCxHxhMVdmMScPxlkVEB+UMWautpAXQUBnuwkB3lZVxBbYNwTk5IUEmwISC3LOELAPDSC61FYTLwHiiPlQwF4JHjynfUnjTI7EU+MS5NMp7UFwly8WJGb2QI+IBo5/LjOnf8u9TF2Ks/b6S73MGfk0jrF1XT1mdoA2DDZjC7jenZYf3AfPf1v/Y+8QOwKGei8n31bmO32HPzhfc9SUAOLvwLepK1/oq8TtedVwGy9eqPtv6+2GVx73XGW4Qt5I3eE3t34SjfhccJqqa6WdxcW+RYDlulNaU114AkSIWRwhAQcK5aQwMFc7BzBcBwonCg5wQshhWgAJdKMAVTn5uF6LTcZuXf+orR8FdAcIBSKCiA9UD8/YF3B2qBp5hQiN9RNHq/FA7RfjN1tsC9h68x4nQI1WBxUBxB8SDAGicni2tc6qgPWts0NFNAQIIT+d9ZNoe49gCHCpyuti4WindgdgqB4Viq+V85yiYHIE+vog7Gh0/Y2SbymeFo6+Z4ijwmmxJa9UhGzsCNBbPwmG4WV4fhZ82f3l04pOy8oKC/XT2u6Xynxa/4cJVdrbhK8+gPEqtLUTynibfPwI8DV5CXWi+kHAgwB9+0eJFXibOxvZF9DY2ewlVhFuu3+PbQH37reFiYUEw13VdwRWBQh3qrvCQWItQX+sqbq7cixghMbu6qaY3+rlw3HoDwciXaFqhgh1RQJhf5T8iwQdTBEkNjY2Njb/nL8AcRZRWA0Qpu4AAAAASUVORK5CYII="
  },
  "metadata": {
    "createdDate": "2018-07-19T00:00:00.000+0000",
    "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
  }
}

HTTP status code 201

Returns a newly created item, with server-controlled fields like 'id' populated

Headers

  • Location: required(string)

    URI to the created Invoice Document item

Body

Media type: application/json

Type: any

Example:

{
  "documentMetadata": {
    "id": "10a34f8a-98d1-45af-a9f6-14b7174ceb51",
    "name": "sample.pdf",
    "invoiceId": "733cafd3-895f-4e33-87b7-bf40dc3c8069",
    "metadata": {
      "createdDate": "2018-07-19T00:00:00.000+0000",
      "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
    }
  },
  "contents": {
    "data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQAAAAEACAMAAABrrFhUAAADAFBMVEVHcEz3+PgAAAD9/f0AAADz9PX19vf+/v79/f4AAAAAAAD6+vvx8vT5+fr7/Pzr7e/7+/v4+fnZ3eHb3uLz9fbk5+r8/P34+fru8PHa3uHi5ejp6+3q7O/09fbt7/D6+/vs7vDd4OTt7/H5+vrj5ur7+/zo6+3l6Ove4eXp7O4BAQHm6esAAAAAAAABAQEAAADv8fIBAQEAAAD29/drbW8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADs7fAAAAD////+/v4A/fj9/f329/j19vfb3+P7+/v4+Pn5+vr7/Pza3uLs7vD09fb8/f36+/v4+fr7+/z8/P39/f7t7/Hr7fDv8PLk5+ry8/Xx8vT8/Pzj5un5+fr+/v/9/v75+fnw6eX+///v8fPw8vPn6eze4uX3+Pnl6Ovp6+3z9Pbq7O7h5Ofm6ezp6+7f4ubz9fXo6u3i5ejg4+bc3+Pf4+fv8/v55O/x8/T5+vvh5Ojr7e/w8fPz9PXc4OPy8/Tg4+fz9fbv8fLw8vT09vfq7O/c4OTn6uzh5elrbW/n6u3m4OBHR0jm6evd4OTX3ODd4eXM09nZ3eLi5unp7O7V2uDI0NbY3OG+yNDS2N3BytLT2d7O1NrHztRJSkrK0ddMTEyuuMPQ1tzZ3eG6w8x9fX1FRkfQ1dvb3+TEzNO1v8motL+dqregrLm9xc60vcfe4ub3+Pixu8WksLyrtsCbqLVERUbS19vk6OvV2t64wcqBkaHt8PLb3+Lj5uqnsr2Rn62UorCirrra3uMqKiswMTKFlaX09ffY3ODx8/WXpLFpfI/j5+p8jZ0VFRV3iZpvgZQJCQmwsbI6PD8eHyBzhZcEBASMm6o0Nzmap7OYmJiLmqglJynx8/OPnqxDSU++wcM/QUTO09d4eXpydHWHl6a4uLlRVFdZXF9hdIeam5y1tbXFyMqrra+fn5+EhYajpahgZGf2+PkRERGQkpPo6+0A/wATchRCAAABAHRSTlMA/gP+av7+/v7+lf7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v4I/t3tWNf+U/j+/nYQK3IBjx4XRwLnOqK9XsWbt6X+//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////8Dp+MUHAAAHOFJREFUeNrsmntMVOkZxhdnXUTWKc6oKDFxibhQRLxQ79e9tI0zAcfCUUTYlhQCpOpCm3EnO8AfgNhRdwc1Xa4ryMWyAg2OyCVcioqIqLDKKq6KKGCo2npZtZpt1/T9vvc7ZwbLoMCZA3/4JORNjAl8v3nf533Od+att97ojd7ojd5o8Fo6RhotHYVnX7Vo+eKVHy0bL4WWrfQcbZ/8ojXe4z+e47AWZfM613tUEVi6/KPxcxc4SCkv71F0/uVLfrUaPxzJOmDtWq/5o+X4nvM/nCPhwfnqMHd0EFi1+AM4/ggAIATGjIKP39tL6oObq9fIO+GKJQvWjhyAtXO9R7gHli9b0OcP+m/Lw31/G4z+aaF/8dq3b98v4OdHqkegh6B/EN29e/36rVuP2gUQI7wLYPwtPpGrd59fe7pzt1oFsleh/q+qiSJDpgQGhwVsTkiYEBQU7ef3xbeTki/u2XLqkw3TP9t+/PTe+PRzOQdyizKyTXkHS45WHy6rKa9rPtPT2nD5xvff/fBDRXe70AkjugtW/NJi9V99dG3aWPtXa5yMaopcPstphuMEZ2c7Ox+fdyZNGnvx3Xmn3vvZ9P2zJ7vtrTISAqWEQAUj0NXcyxPI+zMQ4DWCu2AR9D//SVz9y52NYQN98kKNoD0gC/GlPeCYkAA98B+/d77d9SfSA+9t+C3rgSP99MDN1oYrAMCkXve4ne88hxHzgTELzbN/+ye/Vx1cqJSALBIJzNiMBHy+YAQ+eQUB0gImtWri4w5h9EZqF6xcwAO4+vc7r3FwoRICMjUScAIAhICPHxKYBwSSgIAbI1Dah0DbmR7SAofUKvuo7g7BfEemBxZ/LJjfo3u+gwFACMiIEwYGBssDkIAdccJdyRff3YIE3K30QO/9yzcoAFXUs3aLPDACA4ALEP6Aqz8W+6oGBQAIyNRIQB6GBOyiGYE9SGC2tSkgLUABqKK62815QHonXOnFHn46H8b6qgYJQBUxDrdhoBy3YYIzbsNdYxmB/S/5gLALegFANgWgSu4W8oD0u2DRBw7MhK4Xqy0PGBm8aePupKTpSShr9edffk302fsvXrzYn5Ky3T3meOilLH2iIT62yqjhMtMO5OcWlWYUZh8iH//JyurDtU1nj3W1nbl/+fvvGACV3+MOcx6Q1gdWzfdia7j9juWSl/tMnRynBCmUKOtVQXUBlJaWdgKUn59bX19aWlBw715hNhzclJd3sKLk5FFy+LKmmnJy/N6ehhuwBvlfN7G7w+J+wFPSCMTIdz63aG3fdV/rNCjlK+s5jkiRWQzKoQRO5Ofm1hcRBPDJEwSEQAX5+KvNBFqv0DXIOo7tAuoFUu6CpWu8GIBb+j9Q2cNPwAbtaxxcqJSAgmMEDiCBep5AYWFfArWMABkBMwDIA+3mPCCdD3gu7GQB8FlUBJV9RERQSqpmMAAoAQXHEQDFZBAIglw6BqUF95CAiRGopASICfTAGrQAYO/X3W7OA5IRWPEhM5+79b402arHqYNijHFxcZo41GtVQKAkbQBNoIAmoAgEJ8ggBIgFCkZACfQ2sBzAj15yt5AHpNsFix0QQOdPE/H8all0jJEozmgcRD2CHXEORyEHB4F3AkIg22Qy9SXQLOQAVYCaek/Usw4+D0jmhEvYL2x5KmMAZn6eSrUzdVD1CN8J00gf5MAg8FZACACCQzgGJSdxEzadbWvlc4BaH40giBOa7wckIfBr/IWdj/7IAPhOTR0SgNSdKI2ysbER3ICtRDOBbBwDYR3WdIELMgBcuJ+ajkLU43aL9wVSvDNiIeDqcxmTncF1yEJXPAfhYJpCkXOBESBjQHuALQN+CurABbMxBSiUbj4sDzw23w9IsQs82T1Ax7/VrAOSXNNRQ6joCUghU0GcIM3shfcyCvkeKKEEym823ChkHcBx4Xb0/km1rrvdnAdsT2BxJwJoecoArNcOA0A6HQVgQCAoYQ5yLvDrgI0BT4D4wFl4GDAD4LQJFIB6bHe7dO8LVq1hAK43RsoiiaZ+6vEpaiiVEHBNNRqJGSgbOWoFSCC3SLBCPhLVnGm9kmEGoIgNwjtI/2fm+wGbO+Hb7EXIX/1CZCGgwM91HjrUkGoV64jUVCNdCZmZOcI6IIkgw7wMKsuaWy9bAuDILiDrEFOxA7st95QEwDchIVMIgKDQ4QEAAjgSdCuQWJCZk9OXQDZPoLbtfl8AZBdgHnhscT/gLQ0AX98pvqCNWbEesagh1iocCeIFQEDTyCmKhXXAE0AjONzW09AXACWAecDifcF8iQDICYDk8OECiGWeAF4ATRCnaVTyTgAI2PMhEqjuutlQ0BcAlxWNeWDjs/PmPDDfpgBQ38hRO1x0w5cHiiQDIHCO3BfwY1BksQ6r6wAAywG8lIYJLA88OW/xvmCVZB2wW6/VaVFDr/HYCVW0EeggwD64QJ4OmBFgJqo81tta9FIHcJzBGfOA6kFLp/D9Ads5oQAgMFAeCAIAsewgw6gGHAkk4GrkCdBUVM+Pgelk+Zl+AHAufkjA/kmLcD9gu11gGwCUAHiCjhCAXEAJKIqZFxaxTHTybPP9fgAow/3YO8kH5y3ygEQAtui1BnaQYVWDIVYHEHSAwAMygZE8IWQCgQPkoqQIe6Ckpl8ACtyG5N+fnDe/L5hvYwDBwfJg0JbwRG0iapjVEGsAxYMlQkBMTzUeIWNAm4AF48KKmraefgFwWUERFIA/IeBg011gAWAWAtBr9ahh1kTsCAOMAsnI6UZNnIZfiEigoqntZm6/AOC5IILmgfXgA8L7ApvclAoAwsJmhYF+F65PZAcZdmUTAaNACbjCc6LghYTAwbIuawA47W8wD8AusHhf4GnDHOCEmufmIp4S0Q3AEXUsGMAz4jQFWYhghQV5ZXW9uS/lACEPuLD7AdgF5jzwtqctO8CJdMDu0HCXcNTw614ciUS2FYgVQDKcRp0AUqGpFgBY6QBIxT58Hrgt3A/MWehpMwABAU4BIFEBIAGtHvciBCNKQIlemF9vOnzsTL5VAJwbnweunRfywJwlnrYDMEN8AJSAltoBWYuUAGxE9ML8QwMDUOqDEADdBez7hKvFJvAygC0xoW6hKFHqaQoiay9uBUNsFTwuQy4CM8w5kF1d3jwAAAUXm4B5IOxBi/C+QOwpEABs3uy4GSQ2ACBAOoEQwKVYVeWRjgTSCqvPNh8YCACnjcb7ARUhwLbBnIWLbAlgh9gAQk/TkQACxAwJAY90JJBWWFnTxh6HU/sHwGWx+wGVOQ+I7IT9AJjMDiBaRUvIctGjG+rACsAJGhUZlTVdeezFiBUAwvsCeC4Q8oCoBIQc4Ija4T5ZfLlRZWEygHQMY+DhqlEWnCyrq8Rl/77CipRudvg/plwz3w+I6YRCB2za5LgJtGN7zOQYlHj1OI7EadwKBm18PHihUVNUUnusPJJ+3e731jqA4/TO+E2cKLYNyfcJVy8ZYwMAM20GICYGPQEJwMMS6YJ01/yKw+XNp+iM+6daBcDp6C6IUMsfCPcDDuI54csAtm6LcWd/uKgVPQEIhOupF4AVeOSYqmvacimAsBTrABT0tjxCLYvEGxIHUXeBACAhYWYCaGvKV+5foUSt2AmhocQNw0k60sZXaQqPNtVVBxIA6uRU6wDo/QAB4PtEyAOi7QILABMIgB0p2923o8StOArHj1+65AaDsFefmBifXlpSW16+gbr8+m0DACAEKABf8/2AWKlYMgBQY3AWiBmCF4ARnDhYfbbORAGok3UDAODCo0MoAH9wQn4dirMLXgawNWXb7G0o0StvijgIepdETfbRsrqy6dTlQ5KUAwDg9EEUQKDftdtCHhBlFwg5wBm1NWW27eROxZIBxIKqItgDXSY5XfSy2UrFANLZyWQyudzJ8YH5fkAMJxQ6wN/f2R+058X+bftRNqjCKEAyAC/QZx462nSsbG8k7QGnmP+xd34xbd1XHBfrzEudsXShcSDJAkkNVl6QkPK290jVgJVgNySywTegIdmAscHMREjXYM/8iTFCyUbIBUooiaBRSojJHwgZyaz8wU0RS6JO6aqmalepk/qQh0hTNbRzfudnoFKWrsrv2tdJz8t59L0fn98539+f87vPiYCKiqO6dyECDh30P7q3YX1gn0AAmxGAs8lX7yNTwQ/gUCjAjIi5oKamC0JgaeHmCk17/SfKngOg4mjoCAOwdeP6wAvXgmcAiPAHVsMPsJxABLIhFVRMzFycXRjx0z7A76ytzwHwKyDAADQ+Wt8veOFasAagtnZzLZizaTWySqaKH4hE9kYikRZQBtmu6pq2sffmbkejQ/yI7m9LXWXPKYetoQMMQOjp+n7Bi9aCZwAw8gdWx0MQRJBAywnMBdXNZy9Nzi9E2/m8/+3DpSf++L+rwZ/+wACU9Dxd3y94QQJrACorN1eCSV6v0UumkvcN4HiAnFiAA8EVHzk3OR+Njh5cOzH6ZshTzdaSu8i4ZxuubZUMgCX4aOP6wD4xADIQQK+iNgCv0UcE9rJUUDN8AQgsLE0t/2Bnyu+pCjAAzqf3NqwP7BOgAzLI9KZc1c3ILAKSC6VBzviFmxADs5eMrz23SfE1rgN2b83I3KFzGp5+tEEP/ExYBEgeT66HTD3vbUIz+oABJMOcGxPnJm/PRifH6n5EBMTM/96wX/CbFwdQV5dRByaFPSb+oCp6LyIwQkKM1NefKOgfHrl0+RoEwdyQ/0cAyOYEcH3g5wIBhE1hMlU9zwmUDKunT56+OXdxKRqdnHIfevPt/w+AsZkICALQ2JjRCCZ1dpoSzVBq+rCi5GKnFfVZtTSPj7wHCLCTZG5k0BZzgBlizKz5VjOYLbw9DLxaXIt7+jvaG/oq/jz24cn//EMkgOJkAugMs5ygeEF4QSpw1ZSNIQJsp4tGo/MXL96+PT8/vzQ7OxtdWPjii7/dvXvn668///LLbz/++K9oDx9+8tlnf7//VfoC6AyznAAxQMnQ1RyfmjiNLYXXsK1qfglePoovj+9+B96dvTq8N7442P379588eaJCBNh+sE9QmA8TAUiGvkg9KMO2vuGTE3SUembm8tzc3OTk5DWIBQiEKIIgDEThE/j774sBwHVAMZl+V1bybLuJjOkCUAUFe7ry3hhfO0d3gbqMzs1cpn7DJew1uwsUcBQ8ZAi+4o8vLgJksznLTKa+t/HOU0wFMA2HZOiqfnAKjxddaegr2/bB6PD4GB4mGrlwAUDMrPecYiggApE5oKSkuAQsqQCIgKmTCEAuQHFcvae/raO5/crgNLbd4mGa98+epa7bGUZgdgFGw53PGQGhADIRgJRUAIyAiRVFL1OGbPUYG4+b21sL+4jA1DMIAAIWA+IByFbzLv6AyfG2ziyqioqpCbMhTpOr2aJxa8NgWXwIhsFfaBhAeiQC87NQHOgako9UAGDdZSVLjucRgZHgIV20F4bBrZr+jq523ECsGL1xY2xqncBlRgDSISPwEgCwmvfzSGDJEAjgNJkRaCYCeLgU2+8nNhBYWmIEvn0ZAFj5kLBtZ8nQu8oyAZ4sgWGABLaNcgLrMQA6kQjcE6cDMsn0+Tt37SRLmueWlYWaAJcLIiAJsrP35OR0tF4pzCsbolHwLyJwDglcu0YE7onTAYkIMBjyDWTJ84lIwGwI0+WmVYwCqAY1p9qaj17J6ysbGsZigD1n1G41xxXB3XvihkBpaWYpmByL5dMsLKmehgTVRRNOEgdaWgoWH9yCatA+ONgXJwJYDk+fph58IiAUwA4EIKUGQIxyAk+GRGCvixPARIAExogA673Fe1iAwMsDIEZJkSdDRqAe5v7Vt061UTlEScTK4QTeQ8M0ERB4LByAXFVlqCJLro9ZdyZ0AdNFTBmewCMVOW1YDKa/R+AS10QqAOjpMfSQJdnHWFKksojJUMmFXNiCe4iQCmFy1LdtdHhNErFqAATEA1hxOAwOsqR7PiQoGYbDJhAFuAQGc4N+TATxeIIAzpRJFz8WpwN2kK0UGVJn+WQkCrazhYIBpghOgS4uzJvexu5kQgITEzQ3eixMB5xZXt6yDGYPOIr4P5ICz5MiT4bhsOL1+eoLXIsojNsLB/FqRi4IRiaYKvxU2BA4Y7FssYCFAoGiAFkKvIMlRVYUIRnamDbGROCqfoCjoKEv/gHOj6nrDgkIBaBjAJzOIidZKryDkmJsLRl6FMUIU2S2UoQEyvgKwft0Md1LB8DpcLCqgEGQT8JQMaEsBFGUgwQGy+hyNogCjAEVAPT2BnrJUuR5ToBcAOPAZgNlqNCGSPatftRE02+MDo9jLsRyKBBAd7euG0yWpIBEliLfy3ICEGDJEAhsD+MWGswNqokAzA5xieBDJKAKACd/oJT5ABFYS4YwDBQ2NwACMAzypitGUREggU+F6YAzOp1dB6Z3asCKyFAZ7NyJGxUmUy4tEuzJ6WotzItvw2GA5fAbcTogGLQHwWRZ1stkqfMSYXBQOeDVoGkAqsFiNZXDsjjtGXwjbggEgyEEEAqF9CGyFHoJEQRgLPSALMBkiAhMPjZB7O9oPgqpkAiIB2C32/V2slT6FZYUoSQ4HFWkDKEa4GkCvj0OqbACy+FLCwAJQFVgBFgyZNJY8SKB7FtEAGaH40IB6LUEAAhgVUACRVVEAKsBEihYJAJxkETiAQQ14+2UFHspGcZo0dTjxX0DIjANolAggLV/gIZCMJh6z0yWIBn29FTF2P4BIwCzIyRQ2Bcfui5OB+i52TVk/JFgogiiABcK9u8HSWAcqAdB0MEEwXVxOiBRhuxuu5vZltR7jmEFJwoORz6MA4iBMFYDEIUdXUcb+q6LGwIJIRJ06+gBNOEJABHAJTMkkBX2rrYsPsB5QYNQAE58/1CQ5gTd3ZrwbpYUV1YoGbLVc6gGYS+EAJseqwGApsUWiza8m5KinZKho4qqgWcVVDEKIoEA+HRUawCAAAm0kIzqGIIAt9A6m1pIEL0CACxuO8kCWQ8ThEAVLZQofH3gvHAAdjctjlos2vHuhDDCtQKUxlZz2AeKEErBeXE6gC/NrmzRouFKhc6+ApoAZskGQyw/C8VAQXb2eXE6gC9KrliO7ThGph2/TFUBIgHLAS6XdSooiV2LAocAByBbaIustFRLfpnlBCyKmAx7AzGzoqziavlxcQD4BoU2ATACOgsR0Eu9DjPfLxAPQNImACQAVYERgGQYsIY9Cp4sfWUiAAlgVUACMEN0WsNhT67PVy8QAN+kDPGzQqXa8ztYUex260ATGLD1BiZFQgEYCACdFisp0Z5nGI4tb+l222M2Gzs/cFycDuBb9KFMDRsdYUBZUMTODxiNx8XpAH5URcsRUMKHwrIl2GNmZ4ubBA4BflhJ0wCIAAgjNwHwKAIB8ONq2gZQQlXhmMVBh6s94gHIvHOkRKueqoKTH64WD2Cl5GrxVTJtehoKvWa2TxBWAwA1TzU2atV/xwDQGaJOgQD46W3tA2gsTgAwiwHAdQA/vK8vTgPLzHSyo4RZJoE6gHdwSGkQAY3flQTMwofAOoAM/kMa9tjdxxovxQMIXaV7BOrqtOyvyrzx8pUFEOKNlyoAaKS7RCortewbQ9ZXHgD1GwoEwFtZ5fQAgDlgv02oDuAt/fqMzWlgGXp+/4BAHcB7eOV36E6x2lot+3dk8WUwHQEILYMJAHV0r2B5uZZ9nSy+DL7qAI7bbFk2sHQBYKPnFQiAX28jVdLlquXlWvaVEr+ORygAEwHwb/WTadgzAKZOoTqAX+mj37opDWyrnj+uOB2wFgG1dMO0369lXysyAr4PQE4PALKaAHbzH9KwVwMAv+hQLqcPLRw8qGVfLvOLGQUC4FdepgkAiV/RKRQAu/T0n+kBwMkvaRUPACLgdf5DGvYsAkQBIDvO7/zVb3o9DWyTnj+uQB2gKEYFTPbTF6cOHdKy90sKPa/AIcCvvpbSBAC/llcVAL/mP6RhrwaApiYj3nct+em7gwcOaNn7pSZ6XoEA+P3/aQLAyb9XIBQA+wJEb/oAiPwEQAwArgMiEfbpC/3uX6aB7dZH6HkF6gD+ORzJT98fPnJEy97v5J/vETgE1gG8xX9Iw94viQfAh4Dkp4+wHz6sZe+XEkNAJAD8/k/EmR4AnBF63p8AiAdw8N1f/Le98wlpI4vj+CNZcGPBlpUWt5cSsDUN0dZBE5OYNP5rdxqCFrQq/tm6GFtoo/QQGBjtRaIED4vCEoQ9r1uQeu5JL3pT8FQYLUMOPWRdqSVEKvSwM/n9xk2P67zZfY+dD+jvNvm+j7/35qcH3xDAcB22QMD0dIN+ExovAqYhL8U5AO4CbEjdqOGAGymMS3EOwKsxU4946IBHKbzKk+IWOBeQqEkADFcrBOD1uLwIwOt8bQH0BOBV2Rk+BGTwSm9bgC2A2hxwFcjcvMYBNzMYl+IcYHTAyNi1MYDhOkJ/C2xMTFyd0OBFwATk3aApoL4soH/MiR/EcO3XBdRbIuBF/zPnM4Dh2v/COgGTPAiYtE5AZjLujAMM18mMLYCeAGCjHrhb4+SAmrsYl97/EdpIJq8nNZb46IClJOSluAVsAbYAW8D/W8Dy8vVlDV4ELENeigJkeV7WeMKHgCcy5KU4B6SBOj7mgDqMS3EOkOU0Zx2QptQBtgBbQFnA/Hx2XmN79Om3TwGG6+j2POS1REAVfhDD9VwAvf8rrL0Fsvqxuj30vOo5wHAd2k5DXqoCZjkTMEtJAM4Bs0Cds4oDnHUYl979ApvptFTugMTDqocAwzWhd4BEdQtsZrNSVoMXAVnIawuwBVATMDsrlQ9BPgToh6Cel6oAD2cCPJYIeDzKg4DRxxQFAJse4NYVHuaAK7cwLsU5QJI8ksb0MA8dMDwtQV6KWwAFyFM8CJiSqQv4Yx8ESINx9gXEByUQsG/+srWYCgLypRnPjM44DwLG9aRa3hJevq7GLrr+aAAFfDiYcZcFpEfYFzCS1pNqeQ92UUDgwh3gFUDA++Kqe7XMEvsClspBtbzF9yBA8F5YAPGBAOVPQ0DyEusChpMoYOBYAQG+i6+fPMA36cnvbsBzmfU/Bvzgwai/nWD4ByYEtEEHiHsH2AGr2QW2O+Cn9Cp2wMGeCB3wjQkBARcIUD9/hwI8yV6WBfT+ijnd659VEOAKmBDQ3gkCxHxhMVdmMScPxlkVEB+UMWautpAXQUBnuwkB3lZVxBbYNwTk5IUEmwISC3LOELAPDSC61FYTLwHiiPlQwF4JHjynfUnjTI7EU+MS5NMp7UFwly8WJGb2QI+IBo5/LjOnf8u9TF2Ks/b6S73MGfk0jrF1XT1mdoA2DDZjC7jenZYf3AfPf1v/Y+8QOwKGei8n31bmO32HPzhfc9SUAOLvwLepK1/oq8TtedVwGy9eqPtv6+2GVx73XGW4Qt5I3eE3t34SjfhccJqqa6WdxcW+RYDlulNaU114AkSIWRwhAQcK5aQwMFc7BzBcBwonCg5wQshhWgAJdKMAVTn5uF6LTcZuXf+orR8FdAcIBSKCiA9UD8/YF3B2qBp5hQiN9RNHq/FA7RfjN1tsC9h68x4nQI1WBxUBxB8SDAGicni2tc6qgPWts0NFNAQIIT+d9ZNoe49gCHCpyuti4WindgdgqB4Viq+V85yiYHIE+vog7Gh0/Y2SbymeFo6+Z4ijwmmxJa9UhGzsCNBbPwmG4WV4fhZ82f3l04pOy8oKC/XT2u6Xynxa/4cJVdrbhK8+gPEqtLUTynibfPwI8DV5CXWi+kHAgwB9+0eJFXibOxvZF9DY2ewlVhFuu3+PbQH37reFiYUEw13VdwRWBQh3qrvCQWItQX+sqbq7cixghMbu6qaY3+rlw3HoDwciXaFqhgh1RQJhf5T8iwQdTBEkNjY2Njb/nL8AcRZRWA0Qpu4AAAAASUVORK5CYII="
  },
  "metadata": {
    "createdDate": "2018-07-19T00:00:00.000+0000",
    "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
  }
}

HTTP status code 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

"unable to add Invoice Document -- malformed JSON at 13:3"

HTTP status code 401

Not authorized to perform requested action

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

unable to create Invoice Document -- unauthorized

HTTP status code 413

Invoice Document too large

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

unable to create Invoice Document -- unauthorized

HTTP status code 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "errors.schema",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "error.schema",
        "description": "An error",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message text"
          },
          "type": {
            "type": "string",
            "description": "Error message type"
          },
          "code": {
            "type": "string",
            "description": "Error message code"
          },
          "parameters": {
            "description": "Error message parameters",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "parameters.schema",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "total_records": {
      "description": "Total number of errors",
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

get delete

Get and Delete a specific document attachments/links. Update operation is not allowed

get

Retrieve document item with given {documentId}

delete

Delete document item with given {documentId}

Retrieve document item with given {documentId}

URI Parameters

  • id: required(string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)

    The UUID of an invoice

  • documentId: required(string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)

    The UUID of a document

HTTP status code 200

Returns item with a given ID

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Document attached/associated with an invoice either via a hyperlink to the document or by direct upload and storage within FOLIO",
  "type": "object",
  "properties": {
    "documentMetadata": {
      "description": "Document metadata",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "id": {
          "description": "UUID of the attached document",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "type": "string",
          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
        },
        "name": {
          "description": "The original document name for display purposes (filename or link 'nickname')",
          "type": "string"
        },
        "invoiceId": {
          "description": "UUID of the invoice the document is attached to",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "type": "string",
          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
        },
        "url": {
          "description": "URL pointing to the document",
          "type": "string",
          "pattern": "\\b((?:[a-z][\\w-]+:(?:/{1,3}|[a-z0-9%])|www\\d{0,3}[.]|[a-z0-9.\\-]+[.][a-z]{2,4}/)(?:[^\\s()<>]+|\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\))+(?:\\(([^\\s()<>]+|(\\([^\\s()<>]+\\)))*\\)|[^\\s`!()\\[\\]{};:'\".,<>?]))"
        },
        "metadata": {
          "type": "object",
          "readonly": true,
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "metadata.schema",
          "title": "Metadata Schema",
          "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
          "properties": {
            "createdDate": {
              "description": "Date and time when the record was created",
              "type": "string",
              "format": "date-time"
            },
            "createdByUserId": {
              "description": "ID of the user who created the record (when available)",
              "type": "string",
              "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
            },
            "createdByUsername": {
              "description": "Username of the user who created the record (when available)",
              "type": "string"
            },
            "updatedDate": {
              "description": "Date and time when the record was last updated",
              "type": "string",
              "format": "date-time"
            },
            "updatedByUserId": {
              "description": "ID of the user who last updated the record (when available)",
              "type": "string",
              "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
            },
            "updatedByUsername": {
              "description": "Username of the user who last updated the record (when available)",
              "type": "string"
            }
          },
          "additionalProperties": false,
          "required": [
            "createdDate"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "name",
        "invoiceId"
      ]
    },
    "contents": {
      "description": "Base64 encoded file data",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "data": {
          "description": "Base64 encoded file data",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "data"
      ]
    },
    "metadata": {
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "documentMetadata"
  ]
}

Example:

{
  "documentMetadata": {
    "id": "10a34f8a-98d1-45af-a9f6-14b7174ceb51",
    "name": "sample.pdf",
    "invoiceId": "733cafd3-895f-4e33-87b7-bf40dc3c8069",
    "metadata": {
      "createdDate": "2018-07-19T00:00:00.000+0000",
      "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
    }
  },
  "contents": {
    "data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQAAAAEACAMAAABrrFhUAAADAFBMVEVHcEz3+PgAAAD9/f0AAADz9PX19vf+/v79/f4AAAAAAAD6+vvx8vT5+fr7/Pzr7e/7+/v4+fnZ3eHb3uLz9fbk5+r8/P34+fru8PHa3uHi5ejp6+3q7O/09fbt7/D6+/vs7vDd4OTt7/H5+vrj5ur7+/zo6+3l6Ove4eXp7O4BAQHm6esAAAAAAAABAQEAAADv8fIBAQEAAAD29/drbW8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADs7fAAAAD////+/v4A/fj9/f329/j19vfb3+P7+/v4+Pn5+vr7/Pza3uLs7vD09fb8/f36+/v4+fr7+/z8/P39/f7t7/Hr7fDv8PLk5+ry8/Xx8vT8/Pzj5un5+fr+/v/9/v75+fnw6eX+///v8fPw8vPn6eze4uX3+Pnl6Ovp6+3z9Pbq7O7h5Ofm6ezp6+7f4ubz9fXo6u3i5ejg4+bc3+Pf4+fv8/v55O/x8/T5+vvh5Ojr7e/w8fPz9PXc4OPy8/Tg4+fz9fbv8fLw8vT09vfq7O/c4OTn6uzh5elrbW/n6u3m4OBHR0jm6evd4OTX3ODd4eXM09nZ3eLi5unp7O7V2uDI0NbY3OG+yNDS2N3BytLT2d7O1NrHztRJSkrK0ddMTEyuuMPQ1tzZ3eG6w8x9fX1FRkfQ1dvb3+TEzNO1v8motL+dqregrLm9xc60vcfe4ub3+Pixu8WksLyrtsCbqLVERUbS19vk6OvV2t64wcqBkaHt8PLb3+Lj5uqnsr2Rn62UorCirrra3uMqKiswMTKFlaX09ffY3ODx8/WXpLFpfI/j5+p8jZ0VFRV3iZpvgZQJCQmwsbI6PD8eHyBzhZcEBASMm6o0Nzmap7OYmJiLmqglJynx8/OPnqxDSU++wcM/QUTO09d4eXpydHWHl6a4uLlRVFdZXF9hdIeam5y1tbXFyMqrra+fn5+EhYajpahgZGf2+PkRERGQkpPo6+0A/wATchRCAAABAHRSTlMA/gP+av7+/v7+lf7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v7+/v4I/t3tWNf+U/j+/nYQK3IBjx4XRwLnOqK9XsWbt6X+//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////8Dp+MUHAAAHOFJREFUeNrsmntMVOkZxhdnXUTWKc6oKDFxibhQRLxQ79e9tI0zAcfCUUTYlhQCpOpCm3EnO8AfgNhRdwc1Xa4ryMWyAg2OyCVcioqIqLDKKq6KKGCo2npZtZpt1/T9vvc7ZwbLoMCZA3/4JORNjAl8v3nf533Od+att97ojd7ojd5o8Fo6RhotHYVnX7Vo+eKVHy0bL4WWrfQcbZ/8ojXe4z+e47AWZfM613tUEVi6/KPxcxc4SCkv71F0/uVLfrUaPxzJOmDtWq/5o+X4nvM/nCPhwfnqMHd0EFi1+AM4/ggAIATGjIKP39tL6oObq9fIO+GKJQvWjhyAtXO9R7gHli9b0OcP+m/Lw31/G4z+aaF/8dq3b98v4OdHqkegh6B/EN29e/36rVuP2gUQI7wLYPwtPpGrd59fe7pzt1oFsleh/q+qiSJDpgQGhwVsTkiYEBQU7ef3xbeTki/u2XLqkw3TP9t+/PTe+PRzOQdyizKyTXkHS45WHy6rKa9rPtPT2nD5xvff/fBDRXe70AkjugtW/NJi9V99dG3aWPtXa5yMaopcPstphuMEZ2c7Ox+fdyZNGnvx3Xmn3vvZ9P2zJ7vtrTISAqWEQAUj0NXcyxPI+zMQ4DWCu2AR9D//SVz9y52NYQN98kKNoD0gC/GlPeCYkAA98B+/d77d9SfSA+9t+C3rgSP99MDN1oYrAMCkXve4ne88hxHzgTELzbN/+ye/Vx1cqJSALBIJzNiMBHy+YAQ+eQUB0gImtWri4w5h9EZqF6xcwAO4+vc7r3FwoRICMjUScAIAhICPHxKYBwSSgIAbI1Dah0DbmR7SAofUKvuo7g7BfEemBxZ/LJjfo3u+gwFACMiIEwYGBssDkIAdccJdyRff3YIE3K30QO/9yzcoAFXUs3aLPDACA4ALEP6Aqz8W+6oGBQAIyNRIQB6GBOyiGYE9SGC2tSkgLUABqKK62815QHonXOnFHn46H8b6qgYJQBUxDrdhoBy3YYIzbsNdYxmB/S/5gLALegFANgWgSu4W8oD0u2DRBw7MhK4Xqy0PGBm8aePupKTpSShr9edffk302fsvXrzYn5Ky3T3meOilLH2iIT62yqjhMtMO5OcWlWYUZh8iH//JyurDtU1nj3W1nbl/+fvvGACV3+MOcx6Q1gdWzfdia7j9juWSl/tMnRynBCmUKOtVQXUBlJaWdgKUn59bX19aWlBw715hNhzclJd3sKLk5FFy+LKmmnJy/N6ehhuwBvlfN7G7w+J+wFPSCMTIdz63aG3fdV/rNCjlK+s5jkiRWQzKoQRO5Ofm1hcRBPDJEwSEQAX5+KvNBFqv0DXIOo7tAuoFUu6CpWu8GIBb+j9Q2cNPwAbtaxxcqJSAgmMEDiCBep5AYWFfArWMABkBMwDIA+3mPCCdD3gu7GQB8FlUBJV9RERQSqpmMAAoAQXHEQDFZBAIglw6BqUF95CAiRGopASICfTAGrQAYO/X3W7OA5IRWPEhM5+79b402arHqYNijHFxcZo41GtVQKAkbQBNoIAmoAgEJ8ggBIgFCkZACfQ2sBzAj15yt5AHpNsFix0QQOdPE/H8all0jJEozmgcRD2CHXEORyEHB4F3AkIg22Qy9SXQLOQAVYCaek/Usw4+D0jmhEvYL2x5KmMAZn6eSrUzdVD1CN8J00gf5MAg8FZACACCQzgGJSdxEzadbWvlc4BaH40giBOa7wckIfBr/IWdj/7IAPhOTR0SgNSdKI2ysbER3ICtRDOBbBwDYR3WdIELMgBcuJ+ajkLU43aL9wVSvDNiIeDqcxmTncF1yEJXPAfhYJpCkXOBESBjQHuALQN+CurABbMxBSiUbj4sDzw23w9IsQs82T1Ax7/VrAOSXNNRQ6joCUghU0GcIM3shfcyCvkeKKEEym823ChkHcBx4Xb0/km1rrvdnAdsT2BxJwJoecoArNcOA0A6HQVgQCAoYQ5yLvDrgI0BT4D4wFl4GDAD4LQJFIB6bHe7dO8LVq1hAK43RsoiiaZ+6vEpaiiVEHBNNRqJGSgbOWoFSCC3SLBCPhLVnGm9kmEGoIgNwjtI/2fm+wGbO+Hb7EXIX/1CZCGgwM91HjrUkGoV64jUVCNdCZmZOcI6IIkgw7wMKsuaWy9bAuDILiDrEFOxA7st95QEwDchIVMIgKDQ4QEAAjgSdCuQWJCZk9OXQDZPoLbtfl8AZBdgHnhscT/gLQ0AX98pvqCNWbEesagh1iocCeIFQEDTyCmKhXXAE0AjONzW09AXACWAecDifcF8iQDICYDk8OECiGWeAF4ATRCnaVTyTgAI2PMhEqjuutlQ0BcAlxWNeWDjs/PmPDDfpgBQ38hRO1x0w5cHiiQDIHCO3BfwY1BksQ6r6wAAywG8lIYJLA88OW/xvmCVZB2wW6/VaVFDr/HYCVW0EeggwD64QJ4OmBFgJqo81tta9FIHcJzBGfOA6kFLp/D9Ads5oQAgMFAeCAIAsewgw6gGHAkk4GrkCdBUVM+Pgelk+Zl+AHAufkjA/kmLcD9gu11gGwCUAHiCjhCAXEAJKIqZFxaxTHTybPP9fgAow/3YO8kH5y3ygEQAtui1BnaQYVWDIVYHEHSAwAMygZE8IWQCgQPkoqQIe6Ckpl8ACtyG5N+fnDe/L5hvYwDBwfJg0JbwRG0iapjVEGsAxYMlQkBMTzUeIWNAm4AF48KKmraefgFwWUERFIA/IeBg011gAWAWAtBr9ahh1kTsCAOMAsnI6UZNnIZfiEigoqntZm6/AOC5IILmgfXgA8L7ApvclAoAwsJmhYF+F65PZAcZdmUTAaNACbjCc6LghYTAwbIuawA47W8wD8AusHhf4GnDHOCEmufmIp4S0Q3AEXUsGMAz4jQFWYhghQV5ZXW9uS/lACEPuLD7AdgF5jzwtqctO8CJdMDu0HCXcNTw614ciUS2FYgVQDKcRp0AUqGpFgBY6QBIxT58Hrgt3A/MWehpMwABAU4BIFEBIAGtHvciBCNKQIlemF9vOnzsTL5VAJwbnweunRfywJwlnrYDMEN8AJSAltoBWYuUAGxE9ML8QwMDUOqDEADdBez7hKvFJvAygC0xoW6hKFHqaQoiay9uBUNsFTwuQy4CM8w5kF1d3jwAAAUXm4B5IOxBi/C+QOwpEABs3uy4GSQ2ACBAOoEQwKVYVeWRjgTSCqvPNh8YCACnjcb7ARUhwLbBnIWLbAlgh9gAQk/TkQACxAwJAY90JJBWWFnTxh6HU/sHwGWx+wGVOQ+I7IT9AJjMDiBaRUvIctGjG+rACsAJGhUZlTVdeezFiBUAwvsCeC4Q8oCoBIQc4Ija4T5ZfLlRZWEygHQMY+DhqlEWnCyrq8Rl/77CipRudvg/plwz3w+I6YRCB2za5LgJtGN7zOQYlHj1OI7EadwKBm18PHihUVNUUnusPJJ+3e731jqA4/TO+E2cKLYNyfcJVy8ZYwMAM20GICYGPQEJwMMS6YJ01/yKw+XNp+iM+6daBcDp6C6IUMsfCPcDDuI54csAtm6LcWd/uKgVPQEIhOupF4AVeOSYqmvacimAsBTrABT0tjxCLYvEGxIHUXeBACAhYWYCaGvKV+5foUSt2AmhocQNw0k60sZXaQqPNtVVBxIA6uRU6wDo/QAB4PtEyAOi7QILABMIgB0p2923o8StOArHj1+65AaDsFefmBifXlpSW16+gbr8+m0DACAEKABf8/2AWKlYMgBQY3AWiBmCF4ARnDhYfbbORAGok3UDAODCo0MoAH9wQn4dirMLXgawNWXb7G0o0StvijgIepdETfbRsrqy6dTlQ5KUAwDg9EEUQKDftdtCHhBlFwg5wBm1NWW27eROxZIBxIKqItgDXSY5XfSy2UrFANLZyWQyudzJ8YH5fkAMJxQ6wN/f2R+058X+bftRNqjCKEAyAC/QZx462nSsbG8k7QGnmP+xd34xbd1XHBfrzEudsXShcSDJAkkNVl6QkPK290jVgJVgNySywTegIdmAscHMREjXYM/8iTFCyUbIBUooiaBRSojJHwgZyaz8wU0RS6JO6aqmalepk/qQh0hTNbRzfudnoFKWrsrv2tdJz8t59L0fn98539+f87vPiYCKiqO6dyECDh30P7q3YX1gn0AAmxGAs8lX7yNTwQ/gUCjAjIi5oKamC0JgaeHmCk17/SfKngOg4mjoCAOwdeP6wAvXgmcAiPAHVsMPsJxABLIhFVRMzFycXRjx0z7A76ytzwHwKyDAADQ+Wt8veOFasAagtnZzLZizaTWySqaKH4hE9kYikRZQBtmu6pq2sffmbkejQ/yI7m9LXWXPKYetoQMMQOjp+n7Bi9aCZwAw8gdWx0MQRJBAywnMBdXNZy9Nzi9E2/m8/+3DpSf++L+rwZ/+wACU9Dxd3y94QQJrACorN1eCSV6v0UumkvcN4HiAnFiAA8EVHzk3OR+Njh5cOzH6ZshTzdaSu8i4ZxuubZUMgCX4aOP6wD4xADIQQK+iNgCv0UcE9rJUUDN8AQgsLE0t/2Bnyu+pCjAAzqf3NqwP7BOgAzLI9KZc1c3ILAKSC6VBzviFmxADs5eMrz23SfE1rgN2b83I3KFzGp5+tEEP/ExYBEgeT66HTD3vbUIz+oABJMOcGxPnJm/PRifH6n5EBMTM/96wX/CbFwdQV5dRByaFPSb+oCp6LyIwQkKM1NefKOgfHrl0+RoEwdyQ/0cAyOYEcH3g5wIBhE1hMlU9zwmUDKunT56+OXdxKRqdnHIfevPt/w+AsZkICALQ2JjRCCZ1dpoSzVBq+rCi5GKnFfVZtTSPj7wHCLCTZG5k0BZzgBlizKz5VjOYLbw9DLxaXIt7+jvaG/oq/jz24cn//EMkgOJkAugMs5ygeEF4QSpw1ZSNIQJsp4tGo/MXL96+PT8/vzQ7OxtdWPjii7/dvXvn668///LLbz/++K9oDx9+8tlnf7//VfoC6AyznAAxQMnQ1RyfmjiNLYXXsK1qfglePoovj+9+B96dvTq8N7442P379588eaJCBNh+sE9QmA8TAUiGvkg9KMO2vuGTE3SUembm8tzc3OTk5DWIBQiEKIIgDEThE/j774sBwHVAMZl+V1bybLuJjOkCUAUFe7ry3hhfO0d3gbqMzs1cpn7DJew1uwsUcBQ8ZAi+4o8vLgJksznLTKa+t/HOU0wFMA2HZOiqfnAKjxddaegr2/bB6PD4GB4mGrlwAUDMrPecYiggApE5oKSkuAQsqQCIgKmTCEAuQHFcvae/raO5/crgNLbd4mGa98+epa7bGUZgdgFGw53PGQGhADIRgJRUAIyAiRVFL1OGbPUYG4+b21sL+4jA1DMIAAIWA+IByFbzLv6AyfG2ziyqioqpCbMhTpOr2aJxa8NgWXwIhsFfaBhAeiQC87NQHOgako9UAGDdZSVLjucRgZHgIV20F4bBrZr+jq523ECsGL1xY2xqncBlRgDSISPwEgCwmvfzSGDJEAjgNJkRaCYCeLgU2+8nNhBYWmIEvn0ZAFj5kLBtZ8nQu8oyAZ4sgWGABLaNcgLrMQA6kQjcE6cDMsn0+Tt37SRLmueWlYWaAJcLIiAJsrP35OR0tF4pzCsbolHwLyJwDglcu0YE7onTAYkIMBjyDWTJ84lIwGwI0+WmVYwCqAY1p9qaj17J6ysbGsZigD1n1G41xxXB3XvihkBpaWYpmByL5dMsLKmehgTVRRNOEgdaWgoWH9yCatA+ONgXJwJYDk+fph58IiAUwA4EIKUGQIxyAk+GRGCvixPARIAExogA673Fe1iAwMsDIEZJkSdDRqAe5v7Vt061UTlEScTK4QTeQ8M0ERB4LByAXFVlqCJLro9ZdyZ0AdNFTBmewCMVOW1YDKa/R+AS10QqAOjpMfSQJdnHWFKksojJUMmFXNiCe4iQCmFy1LdtdHhNErFqAATEA1hxOAwOsqR7PiQoGYbDJhAFuAQGc4N+TATxeIIAzpRJFz8WpwN2kK0UGVJn+WQkCrazhYIBpghOgS4uzJvexu5kQgITEzQ3eixMB5xZXt6yDGYPOIr4P5ICz5MiT4bhsOL1+eoLXIsojNsLB/FqRi4IRiaYKvxU2BA4Y7FssYCFAoGiAFkKvIMlRVYUIRnamDbGROCqfoCjoKEv/gHOj6nrDgkIBaBjAJzOIidZKryDkmJsLRl6FMUIU2S2UoQEyvgKwft0Md1LB8DpcLCqgEGQT8JQMaEsBFGUgwQGy+hyNogCjAEVAPT2BnrJUuR5ToBcAOPAZgNlqNCGSPatftRE02+MDo9jLsRyKBBAd7euG0yWpIBEliLfy3ICEGDJEAhsD+MWGswNqokAzA5xieBDJKAKACd/oJT5ABFYS4YwDBQ2NwACMAzypitGUREggU+F6YAzOp1dB6Z3asCKyFAZ7NyJGxUmUy4tEuzJ6WotzItvw2GA5fAbcTogGLQHwWRZ1stkqfMSYXBQOeDVoGkAqsFiNZXDsjjtGXwjbggEgyEEEAqF9CGyFHoJEQRgLPSALMBkiAhMPjZB7O9oPgqpkAiIB2C32/V2slT6FZYUoSQ4HFWkDKEa4GkCvj0OqbACy+FLCwAJQFVgBFgyZNJY8SKB7FtEAGaH40IB6LUEAAhgVUACRVVEAKsBEihYJAJxkETiAQQ14+2UFHspGcZo0dTjxX0DIjANolAggLV/gIZCMJh6z0yWIBn29FTF2P4BIwCzIyRQ2Bcfui5OB+i52TVk/JFgogiiABcK9u8HSWAcqAdB0MEEwXVxOiBRhuxuu5vZltR7jmEFJwoORz6MA4iBMFYDEIUdXUcb+q6LGwIJIRJ06+gBNOEJABHAJTMkkBX2rrYsPsB5QYNQAE58/1CQ5gTd3ZrwbpYUV1YoGbLVc6gGYS+EAJseqwGApsUWiza8m5KinZKho4qqgWcVVDEKIoEA+HRUawCAAAm0kIzqGIIAt9A6m1pIEL0CACxuO8kCWQ8ThEAVLZQofH3gvHAAdjctjlos2vHuhDDCtQKUxlZz2AeKEErBeXE6gC/NrmzRouFKhc6+ApoAZskGQyw/C8VAQXb2eXE6gC9KrliO7ThGph2/TFUBIgHLAS6XdSooiV2LAocAByBbaIustFRLfpnlBCyKmAx7AzGzoqziavlxcQD4BoU2ATACOgsR0Eu9DjPfLxAPQNImACQAVYERgGQYsIY9Cp4sfWUiAAlgVUACMEN0WsNhT67PVy8QAN+kDPGzQqXa8ztYUex260ATGLD1BiZFQgEYCACdFisp0Z5nGI4tb+l222M2Gzs/cFycDuBb9KFMDRsdYUBZUMTODxiNx8XpAH5URcsRUMKHwrIl2GNmZ4ubBA4BflhJ0wCIAAgjNwHwKAIB8ONq2gZQQlXhmMVBh6s94gHIvHOkRKueqoKTH64WD2Cl5GrxVTJtehoKvWa2TxBWAwA1TzU2atV/xwDQGaJOgQD46W3tA2gsTgAwiwHAdQA/vK8vTgPLzHSyo4RZJoE6gHdwSGkQAY3flQTMwofAOoAM/kMa9tjdxxovxQMIXaV7BOrqtOyvyrzx8pUFEOKNlyoAaKS7RCortewbQ9ZXHgD1GwoEwFtZ5fQAgDlgv02oDuAt/fqMzWlgGXp+/4BAHcB7eOV36E6x2lot+3dk8WUwHQEILYMJAHV0r2B5uZZ9nSy+DL7qAI7bbFk2sHQBYKPnFQiAX28jVdLlquXlWvaVEr+ORygAEwHwb/WTadgzAKZOoTqAX+mj37opDWyrnj+uOB2wFgG1dMO0369lXysyAr4PQE4PALKaAHbzH9KwVwMAv+hQLqcPLRw8qGVfLvOLGQUC4FdepgkAiV/RKRQAu/T0n+kBwMkvaRUPACLgdf5DGvYsAkQBIDvO7/zVb3o9DWyTnj+uQB2gKEYFTPbTF6cOHdKy90sKPa/AIcCvvpbSBAC/llcVAL/mP6RhrwaApiYj3nct+em7gwcOaNn7pSZ6XoEA+P3/aQLAyb9XIBQA+wJEb/oAiPwEQAwArgMiEfbpC/3uX6aB7dZH6HkF6gD+ORzJT98fPnJEy97v5J/vETgE1gG8xX9Iw94viQfAh4Dkp4+wHz6sZe+XEkNAJAD8/k/EmR4AnBF63p8AiAdw8N1f/Le98wlpI4vj+CNZcGPBlpUWt5cSsDUN0dZBE5OYNP5rdxqCFrQq/tm6GFtoo/QQGBjtRaIED4vCEoQ9r1uQeu5JL3pT8FQYLUMOPWRdqSVEKvSwM/n9xk2P67zZfY+dD+jvNvm+j7/35qcH3xDAcB22QMD0dIN+ExovAqYhL8U5AO4CbEjdqOGAGymMS3EOwKsxU4946IBHKbzKk+IWOBeQqEkADFcrBOD1uLwIwOt8bQH0BOBV2Rk+BGTwSm9bgC2A2hxwFcjcvMYBNzMYl+IcYHTAyNi1MYDhOkJ/C2xMTFyd0OBFwATk3aApoL4soH/MiR/EcO3XBdRbIuBF/zPnM4Dh2v/COgGTPAiYtE5AZjLujAMM18mMLYCeAGCjHrhb4+SAmrsYl97/EdpIJq8nNZb46IClJOSluAVsAbYAW8D/W8Dy8vVlDV4ELENeigJkeV7WeMKHgCcy5KU4B6SBOj7mgDqMS3EOkOU0Zx2QptQBtgBbQFnA/Hx2XmN79Om3TwGG6+j2POS1REAVfhDD9VwAvf8rrL0Fsvqxuj30vOo5wHAd2k5DXqoCZjkTMEtJAM4Bs0Cds4oDnHUYl979ApvptFTugMTDqocAwzWhd4BEdQtsZrNSVoMXAVnIawuwBVATMDsrlQ9BPgToh6Cel6oAD2cCPJYIeDzKg4DRxxQFAJse4NYVHuaAK7cwLsU5QJI8ksb0MA8dMDwtQV6KWwAFyFM8CJiSqQv4Yx8ESINx9gXEByUQsG/+srWYCgLypRnPjM44DwLG9aRa3hJevq7GLrr+aAAFfDiYcZcFpEfYFzCS1pNqeQ92UUDgwh3gFUDA++Kqe7XMEvsClspBtbzF9yBA8F5YAPGBAOVPQ0DyEusChpMoYOBYAQG+i6+fPMA36cnvbsBzmfU/Bvzgwai/nWD4ByYEtEEHiHsH2AGr2QW2O+Cn9Cp2wMGeCB3wjQkBARcIUD9/hwI8yV6WBfT+ijnd659VEOAKmBDQ3gkCxHxhMVdmMScPxlkVEB+UMWautpAXQUBnuwkB3lZVxBbYNwTk5IUEmwISC3LOELAPDSC61FYTLwHiiPlQwF4JHjynfUnjTI7EU+MS5NMp7UFwly8WJGb2QI+IBo5/LjOnf8u9TF2Ks/b6S73MGfk0jrF1XT1mdoA2DDZjC7jenZYf3AfPf1v/Y+8QOwKGei8n31bmO32HPzhfc9SUAOLvwLepK1/oq8TtedVwGy9eqPtv6+2GVx73XGW4Qt5I3eE3t34SjfhccJqqa6WdxcW+RYDlulNaU114AkSIWRwhAQcK5aQwMFc7BzBcBwonCg5wQshhWgAJdKMAVTn5uF6LTcZuXf+orR8FdAcIBSKCiA9UD8/YF3B2qBp5hQiN9RNHq/FA7RfjN1tsC9h68x4nQI1WBxUBxB8SDAGicni2tc6qgPWts0NFNAQIIT+d9ZNoe49gCHCpyuti4WindgdgqB4Viq+V85yiYHIE+vog7Gh0/Y2SbymeFo6+Z4ijwmmxJa9UhGzsCNBbPwmG4WV4fhZ82f3l04pOy8oKC/XT2u6Xynxa/4cJVdrbhK8+gPEqtLUTynibfPwI8DV5CXWi+kHAgwB9+0eJFXibOxvZF9DY2ewlVhFuu3+PbQH37reFiYUEw13VdwRWBQh3qrvCQWItQX+sqbq7cixghMbu6qaY3+rlw3HoDwciXaFqhgh1RQJhf5T8iwQdTBEkNjY2Njb/nL8AcRZRWA0Qpu4AAAAASUVORK5CYII="
  },
  "metadata": {
    "createdDate": "2018-07-19T00:00:00.000+0000",
    "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
  }
}

HTTP status code 400

Bad request

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

"unable to process document -- constraint violation"

HTTP status code 404

Item with a given ID not found

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

"document not found"

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

Delete document item with given {documentId}

URI Parameters

  • id: required(string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)

    The UUID of an invoice

  • documentId: required(string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)

    The UUID of a document

HTTP status code 204

Item deleted successfully

HTTP status code 400

Bad request

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

"unable to process document -- constraint violation"

HTTP status code 404

Item with a given ID not found

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

"document not found"

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

get

Past and present fiscal years associated with the invoice

get

Get a list of fiscal years to approve or pay the invoice

Get a list of fiscal years to approve or pay the invoice

URI Parameters

  • id: required(string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)

    The UUID of an invoice

HTTP status code 200

Returns a list of fiscal-year items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A collection of fiscal years",
  "type": "object",
  "properties": {
    "fiscalYears": {
      "description": "The list of fiscal year objects in this collection",
      "type": "array",
      "id": "fiscal_years",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "A fiscal year record",
        "properties": {
          "id": {
            "description": "UUID of the fiscal year record",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "_version": {
            "type": "integer",
            "description": "Record version for optimistic locking"
          },
          "acqUnitIds": {
            "description": "UUIDs of the acquisition units associated with this fiscal year",
            "type": "array",
            "items": {
              "$schema": "http://json-schema.org/draft-04/schema#",
              "description": "The UUID format string",
              "type": "string",
              "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
            }
          },
          "name": {
            "description": "The name of the fiscal year",
            "type": "string"
          },
          "code": {
            "description": "The code of the fiscal year",
            "type": "string"
          },
          "currency": {
            "description": "Currency code which is recorded when the FY ends, otherwise the system currency can be assumed",
            "type": "string"
          },
          "description": {
            "description": "The description of the fiscal year",
            "type": "string"
          },
          "periodStart": {
            "description": "The start date of the fiscal year",
            "type": "string",
            "format": "date-time"
          },
          "periodEnd": {
            "description": "The end date of the fiscal year",
            "type": "string",
            "format": "date-time"
          },
          "series": {
            "description": "The fiscal year series",
            "type": "string"
          },
          "financialSummary": {
            "description": "Includes Funding information and Financial activity",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "object",
            "properties": {
              "allocated": {
                "description": "Summary of all related to this fiscal year budgets allocated",
                "type": "number",
                "readonly": true
              },
              "available": {
                "description": "Summary of all related to this fiscal year budgets available",
                "type": "number",
                "readonly": true
              },
              "unavailable": {
                "description": "Summary of all related to this fiscal year budgets unavailable",
                "type": "number",
                "readonly": true
              },
              "initialAllocation": {
                "description": "Summary of all related to this fiscal year budgets initialAllocation",
                "type": "number",
                "readonly": true
              },
              "allocationTo": {
                "description": "Summary of all related to this fiscal year budgets allocationTo",
                "type": "number",
                "readonly": true
              },
              "allocationFrom": {
                "description": "Summary of all related to this fiscal year budgets allocationFrom",
                "type": "number",
                "readonly": true
              },
              "totalFunding": {
                "description": "Summary of all related to this fiscal year budgets totalFunding",
                "type": "number",
                "readonly": true
              },
              "cashBalance": {
                "description": "Summary of all related to this fiscal year budgets cashBalance",
                "type": "number",
                "readonly": true
              },
              "awaitingPayment": {
                "description": "Summary of all related to this fiscal year budgets awaitingPayment",
                "type": "number",
                "readonly": true
              },
              "credits": {
                "description": "Summary of all related to this fiscal year budgets credits",
                "type": "number",
                "readonly": true
              },
              "encumbered": {
                "description": "Summary of all related to this fiscal year budgets encumbered",
                "type": "number",
                "readonly": true
              },
              "expenditures": {
                "description": "Summary of all related to this ledger budgets expenditures",
                "type": "number",
                "readonly": true
              },
              "overEncumbrance": {
                "description": "Summary of all related to this ledger budgets overEncumbrance",
                "type": "number",
                "readonly": true
              },
              "overExpended": {
                "description": "Summary of all related to this ledger budgets overExpended",
                "type": "number",
                "readonly": true
              }
            },
            "additionalProperties": false
          },
          "metadata": {
            "type": "object",
            "readonly": true,
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "metadata.schema",
            "title": "Metadata Schema",
            "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
            "properties": {
              "createdDate": {
                "description": "Date and time when the record was created",
                "type": "string",
                "format": "date-time"
              },
              "createdByUserId": {
                "description": "ID of the user who created the record (when available)",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
              },
              "createdByUsername": {
                "description": "Username of the user who created the record (when available)",
                "type": "string"
              },
              "updatedDate": {
                "description": "Date and time when the record was last updated",
                "type": "string",
                "format": "date-time"
              },
              "updatedByUserId": {
                "description": "ID of the user who last updated the record (when available)",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
              },
              "updatedByUsername": {
                "description": "Username of the user who last updated the record (when available)",
                "type": "string"
              }
            },
            "additionalProperties": false,
            "required": [
              "createdDate"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "code",
          "name",
          "periodStart",
          "periodEnd"
        ]
      }
    },
    "totalRecords": {
      "description": "The number of objects in this collection",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "fiscalYears",
    "totalRecords"
  ]
}

Example:

{
  "fiscalYears": [
    {
      "id": "ac2164c7-ba3d-1bc2-a12c-e35ceccbfaf2",
      "name": "Fiscal Year 2017",
      "code": "FY2017",
      "currency": "USD",
      "description": "January 1 - December 30",
      "periodStart": "2017-01-01T00:00:00Z",
      "periodEnd": "2017-12-30T23:59:59Z",
      "series": "FY",
      "metadata": {
        "createdDate": "2016-12-17T14:12:42.497+0000",
        "createdByUserId": "bfb64f23-818d-488a-a868-62c40d9510a1",
        "updatedDate": "2017-12-28T08:37:19.263+0000",
        "updatedByUserId": "498492aa-f909-42f6-b154-5bf66e6486ba"
      }
    },
    {
      "id": "517efc6a-f218-4d25-a832-10de4dc32f25",
      "name": "Fiscal decade 2020-2029",
      "code": "FY2029",
      "description": "January 1 - December 30",
      "periodStart": "2020-01-01T00:00:00Z",
      "periodEnd": "2029-12-30T23:59:59Z",
      "series": "FY",
      "metadata": {
        "createdDate": "2019-06-17T14:12:42.497+0000",
        "createdByUserId": "498492aa-f909-42f6-b154-5bf66e6486ba",
        "updatedDate": "2019-08-28T08:37:19.263+0000",
        "updatedByUserId": "7ec56c96-e9f2-4079-9509-86b00f8dacd5"
      }
    }
  ],
  "totalRecords": 2
}

HTTP status code 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

unable to list fiscal-years -- malformed parameter 'query', syntax error at column 6

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

get post

Manage Invoice lines

get

Retrieve a list of invoice-line items.

post

Post an invoice lines to corresponding invoice

Post an invoice lines to corresponding invoice

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "invoice line",
  "javaName": "InvoiceLine",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID of this invoice line",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "accountingCode": {
      "description": "Pulled based on account number.",
      "type": "string"
    },
    "accountNumber": {
      "description": "Account number that the vendor assigned",
      "type": "string"
    },
    "adjustments": {
      "description": "Defined in settings - the amount field will be editable and pro-rate toggle will be editable if enabled for that adjustment",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "Adjustment",
        "properties": {
          "id": {
            "description": "UUID of this adjustment",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "adjustmentId": {
            "description": "UUID of the Invoice adjustment incase of prorated adjustments",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "description": {
            "description": "Displayed in invoice line as a name for the input",
            "type": "string"
          },
          "exportToAccounting": {
            "description": "Whether or not to show this adjustment in batchedVoucherLines",
            "type": "boolean",
            "default": false
          },
          "fundDistributions": {
            "description": "Fund distribution records from which this adjustment will be paid; only valid at invoice level",
            "id": "fundDistributions",
            "type": "array",
            "items": {
              "description": "fund distribution record",
              "type": "object",
              "$schema": "http://json-schema.org/draft-04/schema#",
              "properties": {
                "code": {
                  "description": "The code of the fund associated with this fund distribution",
                  "type": "string"
                },
                "encumbrance": {
                  "description": "UUID of encumbrance record associated with this fund distribution",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "fundId": {
                  "description": "UUID of the fund associated with this fund distribution",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "invoiceLineId": {
                  "description": "UUID of the invoice line associated with this fund distribution",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "distributionType": {
                  "description": "Percentage or amount type of the value property",
                  "type": "string",
                  "enum": [
                    "amount",
                    "percentage"
                  ],
                  "default": "percentage"
                },
                "expenseClassId": {
                  "description": "UUID of the expense class associated with this fund distribution",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "value": {
                  "description": "The percentage of the cost to be applied to this fund",
                  "type": "number"
                }
              },
              "additionalProperties": false,
              "required": [
                "fundId",
                "distributionType",
                "value"
              ]
            }
          },
          "prorate": {
            "description": "Displayed in invoice line per adjustment in toggled on in settings",
            "type": "string",
            "enum": [
              "By line",
              "By amount",
              "By quantity",
              "Not prorated"
            ],
            "default": "Not prorated"
          },
          "relationToTotal": {
            "description": "Relationship of this adjustment to the total;In addition to: added to subtotal;Included in: reported as subtotal portion;Separate from:calculated from subtotal",
            "type": "string",
            "enum": [
              "In addition to",
              "Included in",
              "Separate from"
            ],
            "default": "In addition to"
          },
          "type": {
            "description": "Adjustment type",
            "type": "string",
            "enum": [
              "Percentage",
              "Amount"
            ]
          },
          "value": {
            "description": "Adjustment value",
            "type": "number"
          },
          "totalAmount": {
            "description": "Total adjustment amount",
            "type": "number"
          }
        },
        "additionalProperties": false,
        "required": [
          "description",
          "exportToAccounting",
          "prorate",
          "relationToTotal",
          "type",
          "value"
        ]
      }
    },
    "adjustmentsTotal": {
      "description": "Sum of all invoice line adjustments. This amount is always calculated by system.",
      "type": "number"
    },
    "comment": {
      "description": "Free form commentary",
      "type": "string"
    },
    "description": {
      "description": "Title as captured in the Purchase Order Line. In the absence of a POL link this could be used to describe the POL",
      "type": "string"
    },
    "fundDistributions": {
      "description": "List of fund distributions",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "Invoice/voucher line fund distribution",
        "properties": {
          "code": {
            "description": "The code of the fund associated with this fund distribution",
            "type": "string"
          },
          "encumbrance": {
            "description": "UUID of encumbrance record associated with this fund distribution",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "fundId": {
            "description": "UUID of the fund associated with this fund distribution",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "invoiceLineId": {
            "description": "UUID of the invoice line associated with this fund distribution",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "distributionType": {
            "description": "Percentage or amount type of the value property",
            "type": "string",
            "enum": [
              "amount",
              "percentage"
            ],
            "default": "percentage"
          },
          "expenseClassId": {
            "description": "UUID of the expense class associated with this fund distribution",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "value": {
            "description": "The percentage of the cost to be applied to this fund",
            "type": "number"
          }
        },
        "additionalProperties": false,
        "required": [
          "fundId",
          "distributionType",
          "value"
        ]
      }
    },
    "invoiceId": {
      "description": "UUID of this parent invoice",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "invoiceLineNumber": {
      "description": "Sequentially generated and not editable by the user.",
      "type": "string"
    },
    "invoiceLineStatus": {
      "description": "Invoice line status",
      "type": "string",
      "enum": [
        "Open",
        "Reviewed",
        "Approved",
        "Paid",
        "Cancelled",
        "Error"
      ]
    },
    "poLineId": {
      "description": "UUID of the corresponding purchase order line this invoice line is based on",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "productId": {
      "description": "product identifier",
      "type": "string"
    },
    "productIdType": {
      "description": "the type of product id",
      "type": "string",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "quantity": {
      "description": "quantity",
      "type": "integer"
    },
    "releaseEncumbrance": {
      "description": "This is intended to not only release encumbrances but to indicate that this is the final invoice line for corresponding order line. This should take into account the fiscal year. We may release encumbrance for this FY but for on-going orders expect to encumber again next year.",
      "type": "boolean",
      "default": true
    },
    "subscriptionInfo": {
      "description": "The user should use this field to provide info on the subscription (eg. which volumes are being invoiced). It is MANDATORY if the chk_subscription_overlap is FALSE AND there is no start date provided",
      "type": "string"
    },
    "subscriptionStart": {
      "description": "Subscription start date",
      "type": "string",
      "format": "date-time"
    },
    "subscriptionEnd": {
      "description": "Subscription end date",
      "type": "string",
      "format": "date-time"
    },
    "subTotal": {
      "description": "Invoice line amount before adjustments are applied",
      "type": "number"
    },
    "total": {
      "description": "Invoice line total amount which is sum of subTotal and adjustmentsTotal. This amount is always calculated by system.",
      "type": "number"
    },
    "referenceNumbers": {
      "description": "Reference number items array",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "array",
      "items": {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "Reference number item",
        "type": "object",
        "properties": {
          "refNumber": {
            "description": "a reference number for this purchase order line",
            "type": "string"
          },
          "refNumberType": {
            "description": "the reference number type",
            "type": "string",
            "enum": [
              "Vendor continuation reference number",
              "Vendor order reference number",
              "Vendor subscription reference number",
              "Vendor internal number",
              "Vendor title number"
            ],
            "javaEnums": [
              "CONTINUATION_REF_NUMBER",
              "ORDER_REF_NUMBER",
              "SUBSCRIPTION_REF_NUMBER",
              "INTERNAL_NUMBER",
              "TITLE_NUMBER"
            ]
          },
          "vendorDetailsSource": {
            "description": "the reference number type",
            "type": "string",
            "enum": [
              "OrderLine",
              "InvoiceLine"
            ],
            "javaEnums": [
              "ORDER_LINE",
              "INVOICE_LINE"
            ]
          }
        },
        "additionalProperties": false
      },
      "additionalProperties": false
    },
    "metadata": {
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    },
    "tags": {
      "type": "object",
      "description": "arbitrary tags associated with this invoice line",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "tags.schema",
      "title": "tags",
      "properties": {
        "tagList": {
          "description": "List of tags",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false,
  "required": [
    "description",
    "invoiceId",
    "invoiceLineStatus",
    "subTotal",
    "quantity",
    "releaseEncumbrance"
  ]
}

Example:

{
  "id": "2be1e551-be27-4b03-b770-30e5e8211d19",
  "accountingCode": "0206",
  "accountNumber": "GOBI-HIST-12",
  "adjustments": [
    {
      "description":"Service Fee",
      "exportToAccounting" : false,
      "type":"Amount",
      "value":4.00,
      "prorate":"Not prorated",
      "relationToTotal":"In addition to"
    },
    {
      "description":"Sales Tax",
      "exportToAccounting" : false,
      "type":"Percentage",
      "value":8,
      "prorate":"Not prorated",
      "relationToTotal":"In addition to"
    },
    {
      "adjustmentId": "14263aab-b22b-4ddc-9ecc-3434427c2c8f",
      "exportToAccounting" : false,
      "description":"Shipping",
      "type":"Amount",
      "value":2.50,
      "prorate":"By line",
      "relationToTotal":"In addition to"
    }

  ],
  "adjustmentsTotal": 8.50,
  "comment": "Sample invoice line",
  "description": "Some description",
  "fundDistributions": [
    {
      "code": "USHIST",
      "encumbrance": "1c8fc9f4-d2cc-4bd1-aa9a-cb02291cbe65",
      "expenseClassId" : "5b5ebe3a-cf8b-4f16-a880-46873ef21388",
      "fundId": "1d1574f1-9196-4a57-8d1f-3b2e4309eb81",
      "distributionType": "percentage",
      "value": 50
    },
    {
      "code": "EUHIST",
      "expenseClassId" : "5b5ebe3a-cf8b-4f16-a880-46873ef21388",
      "encumbrance": "5f9bfc74-f6ff-4877-be1f-793f8ce90ade",
      "fundId": "63157e96-0693-426d-b0df-948bacdfdb08",
      "distributionType": "percentage",
      "value": 50
    }
  ],
  "invoiceId": "c0d08448-347b-418a-8c2f-5fb50248d67e",
  "invoiceLineNumber": "1",
  "invoiceLineStatus": "Open",
  "poLineId": "e8971620-8ee4-4f3b-b5b5-93b864df16ed",
  "productId": "9780764354113",
  "productIdType": "8261054f-be78-422d-bd51-4ed9f33c3422",
  "quantity": 3,
  "referenceNumbers": [
    {
      "refNumber": "refNumExample",
      "refNumberType": "Vendor title number",
      "vendorDetailsSource": "InvoiceLine"
    }
  ],
  "releaseEncumbrance": true,
  "subscriptionInfo": "Subscription information",
  "subscriptionStart": "2018-08-01T00:00:00.000+0000",
  "subscriptionEnd": "2019-01-01T00:00:00.000+0000",
  "subTotal": 25.00,
  "total": 33.50,
  "tags": {
      "tagList": [
        "tag"
     ]
   },
  "metadata": {
    "createdDate": "2018-07-19T00:00:00.000+0000",
    "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
  }
}

HTTP status code 201

Returns a newly created item, with server-controlled fields like 'id' populated

Headers

  • Location: required(string)

    URI to the created invoice-line item

Body

Media type: application/json

Type: any

Example:

{
  "id": "2be1e551-be27-4b03-b770-30e5e8211d19",
  "accountingCode": "0206",
  "accountNumber": "GOBI-HIST-12",
  "adjustments": [
    {
      "description":"Service Fee",
      "exportToAccounting" : false,
      "type":"Amount",
      "value":4.00,
      "prorate":"Not prorated",
      "relationToTotal":"In addition to"
    },
    {
      "description":"Sales Tax",
      "exportToAccounting" : false,
      "type":"Percentage",
      "value":8,
      "prorate":"Not prorated",
      "relationToTotal":"In addition to"
    },
    {
      "adjustmentId": "14263aab-b22b-4ddc-9ecc-3434427c2c8f",
      "exportToAccounting" : false,
      "description":"Shipping",
      "type":"Amount",
      "value":2.50,
      "prorate":"By line",
      "relationToTotal":"In addition to"
    }

  ],
  "adjustmentsTotal": 8.50,
  "comment": "Sample invoice line",
  "description": "Some description",
  "fundDistributions": [
    {
      "code": "USHIST",
      "encumbrance": "1c8fc9f4-d2cc-4bd1-aa9a-cb02291cbe65",
      "expenseClassId" : "5b5ebe3a-cf8b-4f16-a880-46873ef21388",
      "fundId": "1d1574f1-9196-4a57-8d1f-3b2e4309eb81",
      "distributionType": "percentage",
      "value": 50
    },
    {
      "code": "EUHIST",
      "expenseClassId" : "5b5ebe3a-cf8b-4f16-a880-46873ef21388",
      "encumbrance": "5f9bfc74-f6ff-4877-be1f-793f8ce90ade",
      "fundId": "63157e96-0693-426d-b0df-948bacdfdb08",
      "distributionType": "percentage",
      "value": 50
    }
  ],
  "invoiceId": "c0d08448-347b-418a-8c2f-5fb50248d67e",
  "invoiceLineNumber": "1",
  "invoiceLineStatus": "Open",
  "poLineId": "e8971620-8ee4-4f3b-b5b5-93b864df16ed",
  "productId": "9780764354113",
  "productIdType": "8261054f-be78-422d-bd51-4ed9f33c3422",
  "quantity": 3,
  "referenceNumbers": [
    {
      "refNumber": "refNumExample",
      "refNumberType": "Vendor title number",
      "vendorDetailsSource": "InvoiceLine"
    }
  ],
  "releaseEncumbrance": true,
  "subscriptionInfo": "Subscription information",
  "subscriptionStart": "2018-08-01T00:00:00.000+0000",
  "subscriptionEnd": "2019-01-01T00:00:00.000+0000",
  "subTotal": 25.00,
  "total": 33.50,
  "tags": {
      "tagList": [
        "tag"
     ]
   },
  "metadata": {
    "createdDate": "2018-07-19T00:00:00.000+0000",
    "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
  }
}

HTTP status code 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

"unable to add invoice-line -- malformed JSON at 13:3"

HTTP status code 401

Not authorized to perform requested action

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

unable to create invoice-lines -- unauthorized

HTTP status code 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "errors.schema",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "error.schema",
        "description": "An error",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message text"
          },
          "type": {
            "type": "string",
            "description": "Error message type"
          },
          "code": {
            "type": "string",
            "description": "Error message code"
          },
          "parameters": {
            "description": "Error message parameters",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "parameters.schema",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "total_records": {
      "description": "Total number of errors",
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

get put delete

Manage invoice line by id

get

Return an invoice line with given {id}

put

Update an invoice line with given {id}

delete

Delete an invoice line with given {id}

Return an invoice line with given {id}

URI Parameters

  • id: required(string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)

    The UUID of a invoice line

HTTP status code 200

Returns item with a given ID

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "invoice line",
  "javaName": "InvoiceLine",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID of this invoice line",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "accountingCode": {
      "description": "Pulled based on account number.",
      "type": "string"
    },
    "accountNumber": {
      "description": "Account number that the vendor assigned",
      "type": "string"
    },
    "adjustments": {
      "description": "Defined in settings - the amount field will be editable and pro-rate toggle will be editable if enabled for that adjustment",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "Adjustment",
        "properties": {
          "id": {
            "description": "UUID of this adjustment",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "adjustmentId": {
            "description": "UUID of the Invoice adjustment incase of prorated adjustments",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "description": {
            "description": "Displayed in invoice line as a name for the input",
            "type": "string"
          },
          "exportToAccounting": {
            "description": "Whether or not to show this adjustment in batchedVoucherLines",
            "type": "boolean",
            "default": false
          },
          "fundDistributions": {
            "description": "Fund distribution records from which this adjustment will be paid; only valid at invoice level",
            "id": "fundDistributions",
            "type": "array",
            "items": {
              "description": "fund distribution record",
              "type": "object",
              "$schema": "http://json-schema.org/draft-04/schema#",
              "properties": {
                "code": {
                  "description": "The code of the fund associated with this fund distribution",
                  "type": "string"
                },
                "encumbrance": {
                  "description": "UUID of encumbrance record associated with this fund distribution",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "fundId": {
                  "description": "UUID of the fund associated with this fund distribution",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "invoiceLineId": {
                  "description": "UUID of the invoice line associated with this fund distribution",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "distributionType": {
                  "description": "Percentage or amount type of the value property",
                  "type": "string",
                  "enum": [
                    "amount",
                    "percentage"
                  ],
                  "default": "percentage"
                },
                "expenseClassId": {
                  "description": "UUID of the expense class associated with this fund distribution",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "value": {
                  "description": "The percentage of the cost to be applied to this fund",
                  "type": "number"
                }
              },
              "additionalProperties": false,
              "required": [
                "fundId",
                "distributionType",
                "value"
              ]
            }
          },
          "prorate": {
            "description": "Displayed in invoice line per adjustment in toggled on in settings",
            "type": "string",
            "enum": [
              "By line",
              "By amount",
              "By quantity",
              "Not prorated"
            ],
            "default": "Not prorated"
          },
          "relationToTotal": {
            "description": "Relationship of this adjustment to the total;In addition to: added to subtotal;Included in: reported as subtotal portion;Separate from:calculated from subtotal",
            "type": "string",
            "enum": [
              "In addition to",
              "Included in",
              "Separate from"
            ],
            "default": "In addition to"
          },
          "type": {
            "description": "Adjustment type",
            "type": "string",
            "enum": [
              "Percentage",
              "Amount"
            ]
          },
          "value": {
            "description": "Adjustment value",
            "type": "number"
          },
          "totalAmount": {
            "description": "Total adjustment amount",
            "type": "number"
          }
        },
        "additionalProperties": false,
        "required": [
          "description",
          "exportToAccounting",
          "prorate",
          "relationToTotal",
          "type",
          "value"
        ]
      }
    },
    "adjustmentsTotal": {
      "description": "Sum of all invoice line adjustments. This amount is always calculated by system.",
      "type": "number"
    },
    "comment": {
      "description": "Free form commentary",
      "type": "string"
    },
    "description": {
      "description": "Title as captured in the Purchase Order Line. In the absence of a POL link this could be used to describe the POL",
      "type": "string"
    },
    "fundDistributions": {
      "description": "List of fund distributions",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "Invoice/voucher line fund distribution",
        "properties": {
          "code": {
            "description": "The code of the fund associated with this fund distribution",
            "type": "string"
          },
          "encumbrance": {
            "description": "UUID of encumbrance record associated with this fund distribution",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "fundId": {
            "description": "UUID of the fund associated with this fund distribution",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "invoiceLineId": {
            "description": "UUID of the invoice line associated with this fund distribution",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "distributionType": {
            "description": "Percentage or amount type of the value property",
            "type": "string",
            "enum": [
              "amount",
              "percentage"
            ],
            "default": "percentage"
          },
          "expenseClassId": {
            "description": "UUID of the expense class associated with this fund distribution",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "value": {
            "description": "The percentage of the cost to be applied to this fund",
            "type": "number"
          }
        },
        "additionalProperties": false,
        "required": [
          "fundId",
          "distributionType",
          "value"
        ]
      }
    },
    "invoiceId": {
      "description": "UUID of this parent invoice",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "invoiceLineNumber": {
      "description": "Sequentially generated and not editable by the user.",
      "type": "string"
    },
    "invoiceLineStatus": {
      "description": "Invoice line status",
      "type": "string",
      "enum": [
        "Open",
        "Reviewed",
        "Approved",
        "Paid",
        "Cancelled",
        "Error"
      ]
    },
    "poLineId": {
      "description": "UUID of the corresponding purchase order line this invoice line is based on",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "productId": {
      "description": "product identifier",
      "type": "string"
    },
    "productIdType": {
      "description": "the type of product id",
      "type": "string",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "quantity": {
      "description": "quantity",
      "type": "integer"
    },
    "releaseEncumbrance": {
      "description": "This is intended to not only release encumbrances but to indicate that this is the final invoice line for corresponding order line. This should take into account the fiscal year. We may release encumbrance for this FY but for on-going orders expect to encumber again next year.",
      "type": "boolean",
      "default": true
    },
    "subscriptionInfo": {
      "description": "The user should use this field to provide info on the subscription (eg. which volumes are being invoiced). It is MANDATORY if the chk_subscription_overlap is FALSE AND there is no start date provided",
      "type": "string"
    },
    "subscriptionStart": {
      "description": "Subscription start date",
      "type": "string",
      "format": "date-time"
    },
    "subscriptionEnd": {
      "description": "Subscription end date",
      "type": "string",
      "format": "date-time"
    },
    "subTotal": {
      "description": "Invoice line amount before adjustments are applied",
      "type": "number"
    },
    "total": {
      "description": "Invoice line total amount which is sum of subTotal and adjustmentsTotal. This amount is always calculated by system.",
      "type": "number"
    },
    "referenceNumbers": {
      "description": "Reference number items array",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "array",
      "items": {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "Reference number item",
        "type": "object",
        "properties": {
          "refNumber": {
            "description": "a reference number for this purchase order line",
            "type": "string"
          },
          "refNumberType": {
            "description": "the reference number type",
            "type": "string",
            "enum": [
              "Vendor continuation reference number",
              "Vendor order reference number",
              "Vendor subscription reference number",
              "Vendor internal number",
              "Vendor title number"
            ],
            "javaEnums": [
              "CONTINUATION_REF_NUMBER",
              "ORDER_REF_NUMBER",
              "SUBSCRIPTION_REF_NUMBER",
              "INTERNAL_NUMBER",
              "TITLE_NUMBER"
            ]
          },
          "vendorDetailsSource": {
            "description": "the reference number type",
            "type": "string",
            "enum": [
              "OrderLine",
              "InvoiceLine"
            ],
            "javaEnums": [
              "ORDER_LINE",
              "INVOICE_LINE"
            ]
          }
        },
        "additionalProperties": false
      },
      "additionalProperties": false
    },
    "metadata": {
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    },
    "tags": {
      "type": "object",
      "description": "arbitrary tags associated with this invoice line",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "tags.schema",
      "title": "tags",
      "properties": {
        "tagList": {
          "description": "List of tags",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false,
  "required": [
    "description",
    "invoiceId",
    "invoiceLineStatus",
    "subTotal",
    "quantity",
    "releaseEncumbrance"
  ]
}

Example:

{
  "id": "2be1e551-be27-4b03-b770-30e5e8211d19",
  "accountingCode": "0206",
  "accountNumber": "GOBI-HIST-12",
  "adjustments": [
    {
      "description":"Service Fee",
      "exportToAccounting" : false,
      "type":"Amount",
      "value":4.00,
      "prorate":"Not prorated",
      "relationToTotal":"In addition to"
    },
    {
      "description":"Sales Tax",
      "exportToAccounting" : false,
      "type":"Percentage",
      "value":8,
      "prorate":"Not prorated",
      "relationToTotal":"In addition to"
    },
    {
      "adjustmentId": "14263aab-b22b-4ddc-9ecc-3434427c2c8f",
      "exportToAccounting" : false,
      "description":"Shipping",
      "type":"Amount",
      "value":2.50,
      "prorate":"By line",
      "relationToTotal":"In addition to"
    }

  ],
  "adjustmentsTotal": 8.50,
  "comment": "Sample invoice line",
  "description": "Some description",
  "fundDistributions": [
    {
      "code": "USHIST",
      "encumbrance": "1c8fc9f4-d2cc-4bd1-aa9a-cb02291cbe65",
      "expenseClassId" : "5b5ebe3a-cf8b-4f16-a880-46873ef21388",
      "fundId": "1d1574f1-9196-4a57-8d1f-3b2e4309eb81",
      "distributionType": "percentage",
      "value": 50
    },
    {
      "code": "EUHIST",
      "expenseClassId" : "5b5ebe3a-cf8b-4f16-a880-46873ef21388",
      "encumbrance": "5f9bfc74-f6ff-4877-be1f-793f8ce90ade",
      "fundId": "63157e96-0693-426d-b0df-948bacdfdb08",
      "distributionType": "percentage",
      "value": 50
    }
  ],
  "invoiceId": "c0d08448-347b-418a-8c2f-5fb50248d67e",
  "invoiceLineNumber": "1",
  "invoiceLineStatus": "Open",
  "poLineId": "e8971620-8ee4-4f3b-b5b5-93b864df16ed",
  "productId": "9780764354113",
  "productIdType": "8261054f-be78-422d-bd51-4ed9f33c3422",
  "quantity": 3,
  "referenceNumbers": [
    {
      "refNumber": "refNumExample",
      "refNumberType": "Vendor title number",
      "vendorDetailsSource": "InvoiceLine"
    }
  ],
  "releaseEncumbrance": true,
  "subscriptionInfo": "Subscription information",
  "subscriptionStart": "2018-08-01T00:00:00.000+0000",
  "subscriptionEnd": "2019-01-01T00:00:00.000+0000",
  "subTotal": 25.00,
  "total": 33.50,
  "tags": {
      "tagList": [
        "tag"
     ]
   },
  "metadata": {
    "createdDate": "2018-07-19T00:00:00.000+0000",
    "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
  }
}

HTTP status code 404

Item with a given ID not found

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

"invoice-line not found"

HTTP status code 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "errors.schema",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "error.schema",
        "description": "An error",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message text"
          },
          "type": {
            "type": "string",
            "description": "Error message type"
          },
          "code": {
            "type": "string",
            "description": "Error message code"
          },
          "parameters": {
            "description": "Error message parameters",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "parameters.schema",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "total_records": {
      "description": "Total number of errors",
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

Update an invoice line with given {id}

URI Parameters

  • id: required(string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)

    The UUID of a invoice line

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "invoice line",
  "javaName": "InvoiceLine",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID of this invoice line",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "accountingCode": {
      "description": "Pulled based on account number.",
      "type": "string"
    },
    "accountNumber": {
      "description": "Account number that the vendor assigned",
      "type": "string"
    },
    "adjustments": {
      "description": "Defined in settings - the amount field will be editable and pro-rate toggle will be editable if enabled for that adjustment",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "Adjustment",
        "properties": {
          "id": {
            "description": "UUID of this adjustment",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "adjustmentId": {
            "description": "UUID of the Invoice adjustment incase of prorated adjustments",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "description": {
            "description": "Displayed in invoice line as a name for the input",
            "type": "string"
          },
          "exportToAccounting": {
            "description": "Whether or not to show this adjustment in batchedVoucherLines",
            "type": "boolean",
            "default": false
          },
          "fundDistributions": {
            "description": "Fund distribution records from which this adjustment will be paid; only valid at invoice level",
            "id": "fundDistributions",
            "type": "array",
            "items": {
              "description": "fund distribution record",
              "type": "object",
              "$schema": "http://json-schema.org/draft-04/schema#",
              "properties": {
                "code": {
                  "description": "The code of the fund associated with this fund distribution",
                  "type": "string"
                },
                "encumbrance": {
                  "description": "UUID of encumbrance record associated with this fund distribution",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "fundId": {
                  "description": "UUID of the fund associated with this fund distribution",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "invoiceLineId": {
                  "description": "UUID of the invoice line associated with this fund distribution",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "distributionType": {
                  "description": "Percentage or amount type of the value property",
                  "type": "string",
                  "enum": [
                    "amount",
                    "percentage"
                  ],
                  "default": "percentage"
                },
                "expenseClassId": {
                  "description": "UUID of the expense class associated with this fund distribution",
                  "$schema": "http://json-schema.org/draft-04/schema#",
                  "type": "string",
                  "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
                },
                "value": {
                  "description": "The percentage of the cost to be applied to this fund",
                  "type": "number"
                }
              },
              "additionalProperties": false,
              "required": [
                "fundId",
                "distributionType",
                "value"
              ]
            }
          },
          "prorate": {
            "description": "Displayed in invoice line per adjustment in toggled on in settings",
            "type": "string",
            "enum": [
              "By line",
              "By amount",
              "By quantity",
              "Not prorated"
            ],
            "default": "Not prorated"
          },
          "relationToTotal": {
            "description": "Relationship of this adjustment to the total;In addition to: added to subtotal;Included in: reported as subtotal portion;Separate from:calculated from subtotal",
            "type": "string",
            "enum": [
              "In addition to",
              "Included in",
              "Separate from"
            ],
            "default": "In addition to"
          },
          "type": {
            "description": "Adjustment type",
            "type": "string",
            "enum": [
              "Percentage",
              "Amount"
            ]
          },
          "value": {
            "description": "Adjustment value",
            "type": "number"
          },
          "totalAmount": {
            "description": "Total adjustment amount",
            "type": "number"
          }
        },
        "additionalProperties": false,
        "required": [
          "description",
          "exportToAccounting",
          "prorate",
          "relationToTotal",
          "type",
          "value"
        ]
      }
    },
    "adjustmentsTotal": {
      "description": "Sum of all invoice line adjustments. This amount is always calculated by system.",
      "type": "number"
    },
    "comment": {
      "description": "Free form commentary",
      "type": "string"
    },
    "description": {
      "description": "Title as captured in the Purchase Order Line. In the absence of a POL link this could be used to describe the POL",
      "type": "string"
    },
    "fundDistributions": {
      "description": "List of fund distributions",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "Invoice/voucher line fund distribution",
        "properties": {
          "code": {
            "description": "The code of the fund associated with this fund distribution",
            "type": "string"
          },
          "encumbrance": {
            "description": "UUID of encumbrance record associated with this fund distribution",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "fundId": {
            "description": "UUID of the fund associated with this fund distribution",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "invoiceLineId": {
            "description": "UUID of the invoice line associated with this fund distribution",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "distributionType": {
            "description": "Percentage or amount type of the value property",
            "type": "string",
            "enum": [
              "amount",
              "percentage"
            ],
            "default": "percentage"
          },
          "expenseClassId": {
            "description": "UUID of the expense class associated with this fund distribution",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "value": {
            "description": "The percentage of the cost to be applied to this fund",
            "type": "number"
          }
        },
        "additionalProperties": false,
        "required": [
          "fundId",
          "distributionType",
          "value"
        ]
      }
    },
    "invoiceId": {
      "description": "UUID of this parent invoice",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "invoiceLineNumber": {
      "description": "Sequentially generated and not editable by the user.",
      "type": "string"
    },
    "invoiceLineStatus": {
      "description": "Invoice line status",
      "type": "string",
      "enum": [
        "Open",
        "Reviewed",
        "Approved",
        "Paid",
        "Cancelled",
        "Error"
      ]
    },
    "poLineId": {
      "description": "UUID of the corresponding purchase order line this invoice line is based on",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "productId": {
      "description": "product identifier",
      "type": "string"
    },
    "productIdType": {
      "description": "the type of product id",
      "type": "string",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "quantity": {
      "description": "quantity",
      "type": "integer"
    },
    "releaseEncumbrance": {
      "description": "This is intended to not only release encumbrances but to indicate that this is the final invoice line for corresponding order line. This should take into account the fiscal year. We may release encumbrance for this FY but for on-going orders expect to encumber again next year.",
      "type": "boolean",
      "default": true
    },
    "subscriptionInfo": {
      "description": "The user should use this field to provide info on the subscription (eg. which volumes are being invoiced). It is MANDATORY if the chk_subscription_overlap is FALSE AND there is no start date provided",
      "type": "string"
    },
    "subscriptionStart": {
      "description": "Subscription start date",
      "type": "string",
      "format": "date-time"
    },
    "subscriptionEnd": {
      "description": "Subscription end date",
      "type": "string",
      "format": "date-time"
    },
    "subTotal": {
      "description": "Invoice line amount before adjustments are applied",
      "type": "number"
    },
    "total": {
      "description": "Invoice line total amount which is sum of subTotal and adjustmentsTotal. This amount is always calculated by system.",
      "type": "number"
    },
    "referenceNumbers": {
      "description": "Reference number items array",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "array",
      "items": {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "Reference number item",
        "type": "object",
        "properties": {
          "refNumber": {
            "description": "a reference number for this purchase order line",
            "type": "string"
          },
          "refNumberType": {
            "description": "the reference number type",
            "type": "string",
            "enum": [
              "Vendor continuation reference number",
              "Vendor order reference number",
              "Vendor subscription reference number",
              "Vendor internal number",
              "Vendor title number"
            ],
            "javaEnums": [
              "CONTINUATION_REF_NUMBER",
              "ORDER_REF_NUMBER",
              "SUBSCRIPTION_REF_NUMBER",
              "INTERNAL_NUMBER",
              "TITLE_NUMBER"
            ]
          },
          "vendorDetailsSource": {
            "description": "the reference number type",
            "type": "string",
            "enum": [
              "OrderLine",
              "InvoiceLine"
            ],
            "javaEnums": [
              "ORDER_LINE",
              "INVOICE_LINE"
            ]
          }
        },
        "additionalProperties": false
      },
      "additionalProperties": false
    },
    "metadata": {
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    },
    "tags": {
      "type": "object",
      "description": "arbitrary tags associated with this invoice line",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "tags.schema",
      "title": "tags",
      "properties": {
        "tagList": {
          "description": "List of tags",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false,
  "required": [
    "description",
    "invoiceId",
    "invoiceLineStatus",
    "subTotal",
    "quantity",
    "releaseEncumbrance"
  ]
}

Example:

{
  "id": "2be1e551-be27-4b03-b770-30e5e8211d19",
  "accountingCode": "0206",
  "accountNumber": "GOBI-HIST-12",
  "adjustments": [
    {
      "description":"Service Fee",
      "exportToAccounting" : false,
      "type":"Amount",
      "value":4.00,
      "prorate":"Not prorated",
      "relationToTotal":"In addition to"
    },
    {
      "description":"Sales Tax",
      "exportToAccounting" : false,
      "type":"Percentage",
      "value":8,
      "prorate":"Not prorated",
      "relationToTotal":"In addition to"
    },
    {
      "adjustmentId": "14263aab-b22b-4ddc-9ecc-3434427c2c8f",
      "exportToAccounting" : false,
      "description":"Shipping",
      "type":"Amount",
      "value":2.50,
      "prorate":"By line",
      "relationToTotal":"In addition to"
    }

  ],
  "adjustmentsTotal": 8.50,
  "comment": "Sample invoice line",
  "description": "Some description",
  "fundDistributions": [
    {
      "code": "USHIST",
      "encumbrance": "1c8fc9f4-d2cc-4bd1-aa9a-cb02291cbe65",
      "expenseClassId" : "5b5ebe3a-cf8b-4f16-a880-46873ef21388",
      "fundId": "1d1574f1-9196-4a57-8d1f-3b2e4309eb81",
      "distributionType": "percentage",
      "value": 50
    },
    {
      "code": "EUHIST",
      "expenseClassId" : "5b5ebe3a-cf8b-4f16-a880-46873ef21388",
      "encumbrance": "5f9bfc74-f6ff-4877-be1f-793f8ce90ade",
      "fundId": "63157e96-0693-426d-b0df-948bacdfdb08",
      "distributionType": "percentage",
      "value": 50
    }
  ],
  "invoiceId": "c0d08448-347b-418a-8c2f-5fb50248d67e",
  "invoiceLineNumber": "1",
  "invoiceLineStatus": "Open",
  "poLineId": "e8971620-8ee4-4f3b-b5b5-93b864df16ed",
  "productId": "9780764354113",
  "productIdType": "8261054f-be78-422d-bd51-4ed9f33c3422",
  "quantity": 3,
  "referenceNumbers": [
    {
      "refNumber": "refNumExample",
      "refNumberType": "Vendor title number",
      "vendorDetailsSource": "InvoiceLine"
    }
  ],
  "releaseEncumbrance": true,
  "subscriptionInfo": "Subscription information",
  "subscriptionStart": "2018-08-01T00:00:00.000+0000",
  "subscriptionEnd": "2019-01-01T00:00:00.000+0000",
  "subTotal": 25.00,
  "total": 33.50,
  "tags": {
      "tagList": [
        "tag"
     ]
   },
  "metadata": {
    "createdDate": "2018-07-19T00:00:00.000+0000",
    "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
  }
}

HTTP status code 204

Item successfully updated

HTTP status code 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

"unable to update invoice-line -- malformed JSON at 13:4"

HTTP status code 404

Item with a given ID not found

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

"invoice-line not found"

HTTP status code 409

Optimistic locking version conflict

Body

Media type: text/plain

Type: any

Example:

version conflict

HTTP status code 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "errors.schema",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "error.schema",
        "description": "An error",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message text"
          },
          "type": {
            "type": "string",
            "description": "Error message type"
          },
          "code": {
            "type": "string",
            "description": "Error message code"
          },
          "parameters": {
            "description": "Error message parameters",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "parameters.schema",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "total_records": {
      "description": "Total number of errors",
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

Delete an invoice line with given {id}

URI Parameters

  • id: required(string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)

    The UUID of a invoice line

HTTP status code 204

Item deleted successfully

HTTP status code 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

"unable to delete invoice-line -- constraint violation"

HTTP status code 404

Item with a given ID not found

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

"invoice-line not found"

HTTP status code 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "errors.schema",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "error.schema",
        "description": "An error",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message text"
          },
          "type": {
            "type": "string",
            "description": "Error message type"
          },
          "code": {
            "type": "string",
            "description": "Error message code"
          },
          "parameters": {
            "description": "Error message parameters",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "parameters.schema",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            }
          }
        },
        "required": [
          "message"
        ]
      }
    },
    "total_records": {
      "description": "Total number of errors",
      "type": "integer"
    }
  }
}

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

put

put

Validate is total amount equals to sum of all fund distributions

get

Manage Invoice Number

get

Get system generated Invoice Number