Chilkat Online Tools

Objective-C / easybill REST API / Create document payment

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "document_id": "<long>",
//   "amount": "<integer>",
//   "id": "<long>",
//   "is_overdue_fee": "<boolean>",
//   "login_id": "<long>",
//   "notice": "",
//   "payment_at": "<date>",
//   "type": "",
//   "provider": "",
//   "reference": ""
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"document_id" value: @"<long>"];
[json UpdateString: @"amount" value: @"<integer>"];
[json UpdateString: @"id" value: @"<long>"];
[json UpdateString: @"is_overdue_fee" value: @"<boolean>"];
[json UpdateString: @"login_id" value: @"<long>"];
[json UpdateString: @"notice" value: @""];
[json UpdateString: @"payment_at" value: @"<date>"];
[json UpdateString: @"type" value: @""];
[json UpdateString: @"provider" value: @""];
[json UpdateString: @"reference" value: @""];

[http SetRequestHeader: @"Content-Type" value: @"application/json"];
[http SetRequestHeader: @"Authorization" value: @"{{apiKey}}"];
[http SetRequestHeader: @"Accept" value: @"application/json"];

CkoHttpResponse *resp = [http PostJson3: @"https://api.easybill.de/rest/v1/document-payments?paid=<boolean>" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"Failed.");

    return;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "document_id": "<long>",
//   "amount": "<integer>",
//   "id": "<long>",
//   "is_overdue_fee": "<boolean>",
//   "login_id": "<long>",
//   "notice": "",
//   "payment_at": "<date>",
//   "type": "",
//   "provider": "",
//   "reference": ""
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

NSString *document_id = [jResp StringOf: @"document_id"];
NSString *amount = [jResp StringOf: @"amount"];
NSString *id = [jResp StringOf: @"id"];
NSString *is_overdue_fee = [jResp StringOf: @"is_overdue_fee"];
NSString *login_id = [jResp StringOf: @"login_id"];
NSString *notice = [jResp StringOf: @"notice"];
NSString *payment_at = [jResp StringOf: @"payment_at"];
NSString *v_type = [jResp StringOf: @"type"];
NSString *provider = [jResp StringOf: @"provider"];
NSString *reference = [jResp StringOf: @"reference"];

Curl Command

curl -X POST
	-H "Authorization: {{apiKey}}"
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "document_id": "<long>",
  "amount": "<integer>",
  "id": "<long>",
  "is_overdue_fee": "<boolean>",
  "login_id": "<long>",
  "notice": "",
  "payment_at": "<date>",
  "type": "",
  "provider": "",
  "reference": ""
}'
https://api.easybill.de/rest/v1/document-payments?paid=<boolean>

Postman Collection Item JSON

{
  "name": "Create document payment",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"document_id\": \"<long>\",\n  \"amount\": \"<integer>\",\n  \"id\": \"<long>\",\n  \"is_overdue_fee\": \"<boolean>\",\n  \"login_id\": \"<long>\",\n  \"notice\": \"\",\n  \"payment_at\": \"<date>\",\n  \"type\": \"\",\n  \"provider\": \"\",\n  \"reference\": \"\"\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/document-payments?paid=<boolean>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "document-payments"
      ],
      "query": [
        {
          "key": "paid",
          "value": "<boolean>",
          "description": "Mark document as paid when amount less then payment amount."
        }
      ]
    }
  },
  "response": [
    {
      "name": "Successful operation",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"document_id\": \"<long>\",\n  \"amount\": \"<integer>\",\n  \"id\": \"<long>\",\n  \"is_overdue_fee\": \"<boolean>\",\n  \"login_id\": \"<long>\",\n  \"notice\": \"\",\n  \"payment_at\": \"<date>\",\n  \"type\": \"\",\n  \"provider\": \"\",\n  \"reference\": \"\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/document-payments?paid=<boolean>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "document-payments"
          ],
          "query": [
            {
              "key": "paid",
              "value": "<boolean>",
              "description": "Mark document as paid when amount less then payment amount."
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"document_id\": \"<long>\",\n  \"amount\": \"<integer>\",\n  \"id\": \"<long>\",\n  \"is_overdue_fee\": \"<boolean>\",\n  \"login_id\": \"<long>\",\n  \"notice\": \"\",\n  \"payment_at\": \"<date>\",\n  \"type\": \"\",\n  \"provider\": \"\",\n  \"reference\": \"\"\n}"
    },
    {
      "name": "Too Many Requests",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "Authorization",
            "value": "<API Key>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"document_id\": \"<long>\",\n  \"amount\": \"<integer>\",\n  \"id\": \"<long>\",\n  \"is_overdue_fee\": \"<boolean>\",\n  \"login_id\": \"<long>\",\n  \"notice\": \"\",\n  \"payment_at\": \"<date>\",\n  \"type\": \"\",\n  \"provider\": \"\",\n  \"reference\": \"\"\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/document-payments?paid=<boolean>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "document-payments"
          ],
          "query": [
            {
              "key": "paid",
              "value": "<boolean>",
              "description": "Mark document as paid when amount less then payment amount."
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}