PEpeakaccount
Invoices

Create Invoice List By Contact

Changed on
get/api/v1/Invoices/listbycontact

Request

Query parameters

contactCodestring

Code of the contact whose documents are listed. Send contactId or contactCode

contactIdstring

The Unique Identifier of the contact whose documents are listed

status2 | 3 | 4 | 5

Status of the documents to list. Only 2 (AwaitApproval), 3 (WaitingPayment), 4 (Overdue) and 5 (Paid) are supported

limitinteger

Maximum number of entries to retrieve

pageinteger

Page number for displaying data, where each page will show 10 entries

Headers

Time-Stampstring required

Timestamp (yyyyMMddHHmmss)

Time-Signaturestring required

HMAC-SHA1 encrypted Time-Stamp where Secret Key is connectId

User-Tokenstring required

This token will be generated by PEAK.

Client-Tokenstring required

Token used to identify between client and PEAK to call API.

Response

Success

eventTypestring
apiTypestring

Changes

  • 433c913c750fRevision changes
    • breaking

      the query request parameter status was restricted to a list of enum values

    • warning

      for the query request parameter limit, the max was set to 100.00

    • warning

      for the query request parameter limit, the min was set to 1.00

    • warning

      for the query request parameter page, the min was set to 1.00

    • info

      added the new enum value 2.00 to the query request parameter status

    • info

      added the new enum value 3.00 to the query request parameter status

    • info

      added the new enum value 4.00 to the query request parameter status

    • info

      added the new enum value 5.00 to the query request parameter status

    • info

      added the optional property /// to the response with the status